pyproject.toml

[build-system]
requires = [
  "poetry-core >=1.8.0",
  "poetry-dynamic-versioning >=1.9.1, ==1.*",
  # list dependencies to work with PIP_NO_DEPS=1
  "MarkupSafe >=2.0",
  "dunamai >=1.25, ==1.*",
  "jinja2 ==3.*",
  "packaging >=24.0",
  "tomlkit >=0.13",
]
build-backend = "poetry_dynamic_versioning.backend"


[project]
name = "simpeg-drivers"
requires-python = ">=3.12, <3.15"

description = "Application to run SimPEG inversions with geoh5 files from Geoscience Analyst."
license = "MIT"
license-files = [
    "LICENSE",
    "docs/THIRD_PARTY_SOFTWARE.rst",
]
keywords = [
    "direct current resistivity",
    "earth science",
    "electromagnetics",
    "geoh5",
    "geophysics",
    "geoscience",
    "inverse problems",
    "inversion",
    "modeling",
    "modelling",
    "open science",
    "simpeg",
]
readme = "package.rst"
dynamic = ["version", "dependencies", "classifiers"]
authors = [{ name = "Mira Geoscience", email = "support@mirageoscience.com" }]
maintainers = [
  { name = "Benjamin Kary", email = "benjamink@mirageoscience.com" },
  { name = "Dominique Fournier", email = "dominiquef@mirageoscience.com" }
]

[project.urls]
repository = "https://github.com/MiraGeoscience/simpeg-drivers"
documentation = "https://mirageoscience-simpeg-drivers.readthedocs-hosted.com/"
homepage = "https://www.mirageoscience.com/mining-industry-software/python-integration/"

[tool.poetry]
requires-poetry = "2.*"

classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Software Development :: Libraries :: Python Modules",
]

packages = [
     { include = "simpeg_drivers" },
     { include = "simpeg_drivers-assets" },
]

include = [
    { path = "simpeg_drivers/_version.py", format = ["sdist", "wheel"] },
]
version = "0.0.0.dev0"

[tool.poetry.dependencies]
# note: py-deps-lock defines custom mapping from dask to dask-core
dask = "~2025.3.0"  # also in simpeg[dask]
discretize = "~0.12.0"  # also in simpeg, grid-apps
distributed = "~2025.3.0"  # for dask[distributed]
matplotlib = "~3.10.0"  # from geoapps-utils
numpy = "~2.4.2"
openpyxl = ">=3.1.2"
pandas = ">=3.0.*"
pydantic = "~2.12.0"  # also in geoh5py, curve-apps, geoapps-utils
pydiso = "~0.2.0"
python-mumps = "~0.0.6.0"
rtree = "~1.4.0"
scikit-learn = "~1.8.0"
scipy = "~1.17.0"
tqdm = "^4.66.1"
trimesh = "~4.1.3"

## Pip dependencies from Git repositories
#----------------------------------------
#geoh5py = {version = ">=0.13.0a2, 0.13.*", source = "pypi", allow-prereleases = true}
geoh5py = {git = "https://github.com/MiraGeoscience/geoh5py.git", rev = "develop"}

#grid-apps = {version = ">=0.2.0a2, 0.2.*", source = "pypi", allow-prereleases = true}
grid-apps = {git = "https://github.com/MiraGeoscience/grid-apps.git", rev = "develop"}

#geoapps-utils = {version = ">=0.7.0a2, 0.7.*", source = "pypi", allow-prereleases = true}
geoapps-utils = {git = "https://github.com/MiraGeoscience/geoapps-utils.git", rev = "develop"}

#mira-simpeg = {version = ">=0.23.0.2, 0.23.0.* || >=0.25.0.1a, 0.25.0.*", source="pypi", allow-prereleases = true, extras = ["dask"]}
mira-simpeg = {git = "https://github.com/MiraGeoscience/simpeg.git", rev = "develop", extras = ["dask"]}

## about pip dependencies
# to be specified to work with conda-lock
# - from PyPI: my_package = { version = "1.2.3", source = "pypi" }
# - from Artifactory : my_package = { version = "1.2.3" }
# - from URL: !!! no actual lock, as tag or branch can move and installation will fetch current !!!
#   - for a tag:    my_package = { url = "https://github.com/ORGANISATION/REPO/archive/refs/tags/TAG.tar.gz" }
#   - for a branch: my_package = { url = "https://github.com/ORGANISATION/REPO/archive/refs/heads/BRANCH.tar.gz" }
# - to actually lock on a revision: my_package = { git = "https://github.com/ORGANISATION/REPO.git", rev = "GIT_REV" }
#   (where rev value is a tag, a branch name or a commit hash). Can also use ``branch`` or ``tag`` instead of ``rev``

[tool.poetry.group.dev.dependencies]
Pygments = "*"
ipywidgets = "^7.6.5"
jupyter-book = "*"
jupytext = "^1.14"
pylint = "*"
pytest = "*"
pytest-cov = "*"
pyyaml = '*'
packaging = '*'
readthedocs-sphinx-ext = "*"
sphinx = "^5.0"
nbconvert = "~7.16.4"

[tool.conda-lock]
platforms = ['win-64', 'linux-64']
channels = ['conda-forge']

[tool.conda-lock.dependencies]
libblas = "*=*mkl"  # because simpeg already brings in the MKL

## indirect dependencies, forcing them here for installation through Conda not pip
#---------------------------------------------------------------------------------
bokeh = "3.6.*"   # optional, for dask reporting
fsspec = ">=2022.0"  # from simpeg[dask]
geoana = "0.8.*"  # from simpeg
h5py = ">=3.15.1, 3.*"  # from geoh5py
pillow = ">=12.1.0, 12.*"  # from geoh5py
pymatsolver = "0.3.*"  # from simpeg
zarr = ">=2.14.2, 2.14.*"  # from simpeg[dask]

[tool.poetry.requires-plugins]
poetry-dynamic-versioning = { version = ">=1.9.1, 1.*", extras = ["plugin"] }

[tool.poetry-dynamic-versioning]
bump = true
enable = true
fix-shallow-repository = true
strict = true
style = "pep440"
vcs = "git"

[tool.poetry-dynamic-versioning.substitution]
files = ["simpeg_drivers/_version.py", "recipe.yaml"]
patterns = [
    { value = '''(^__version__\s*(?::.*?)?=\s*['"])[^'"]*(['"])''', mode = "str" },
    { value = '''(^\s*version\s*(?::.*?)?:\s*['"])[^'"]*(['"])''', mode = "str" },
]

[tool.poetry-dynamic-versioning.files."simpeg_drivers/_version.py"]
persistent-substitution = true
initial-content = """
  # Version placeholder that will be replaced during substitution
  __version__ = "0.0.0"
"""

[tool.poetry-dynamic-versioning.files."recipe.yaml"]
persistent-substitution = true

[tool.ruff]
target-version = "py312"

[tool.ruff.lint]
ignore = [
    "B028",  # no-explicit-stacklevel for warnings.warn()
    "E501",  # line-too-long - code is reformatted (do not care about comments and docstring)
    "F401",  # unsused-import - covered by pycln
    "RUF005",  # collection-literal-concatenation - wrong suggestion with numpy arrays
    "RUF012", # TODO
]
select = [
    "A",  # flake8-builtins
    "B",  # flake8-bugbear
    "B006",  # Do not use mutable data structures for argument defaults
    "B9",  # flake8-bugbear opiniated warnings
    "BLE",  # flake8-blind-except
    "C4",  # flake8-comprehensions
    "C9",  # mccabe
    "E",  # pycodestyle errors
    "F",  # pyflakes
    "I",  # isort
    "RUF",  # ruff rules
    "TID", # flake8-tidy-imports
    "UP",  # pyupgrade
    "W",  # pycodestyle warnings
]

[tool.ruff.lint.mccabe]
max-complexity = 18

[tool.ruff.lint.isort]
lines-after-imports = 2

[tool.ruff.format]
# default formatting is just fine

[tool.mypy]
warn_unused_configs = true
ignore_missing_imports = true
scripts_are_modules = true
show_error_context = true
show_column_numbers = true
check_untyped_defs = true

plugins = [
    "numpy.typing.mypy_plugin",
]

[tool.coverage.run]
branch = true
source = ["simpeg_drivers"]

[tool.coverage.report]
exclude_lines = [
    "raise NotImplementedError",
    "pass",
    "if TYPE_CHECKING",
    "pragma: no cover"
]

fail_under = 85

[tool.coverage.html]
skip_empty = true
skip_covered = true