pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "imod"
dynamic = ["version"]
requires-python = ">=3.11"
authors = [{ name = "Deltares", email = "imod.info@deltares.nl" }, ]
maintainers = [{ name = "Deltares", email = "imod.info@deltares.nl" }]
description = "Make massive MODFLOW models!"
readme = "README.rst"
license = { file = "LICENSE" }
keywords = ["imod", "modflow", "groundwater modeling"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Hydrology",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: Implementation :: CPython",
    "Topic :: Scientific/Engineering"
]
dependencies = [
    "affine",
    "cftime >=1",
    "dask",
    "plum-dispatch",
    "filelock",
    "Jinja2",
    "loguru",
    "matplotlib",
    "numba",
    "numpy",
    "pandas",
    "pooch",
    "pydantic",
    "scipy",
    "tomli >= 1.1.0",
    "tomli_w",
    "toolz",
    "tqdm",
    "xarray >=2023.08.0",
    "xugrid >=0.14.0",
]

[project.urls]
Homepage = "https://github.com/Deltares/imod-python"
Documentation = "https://deltares.github.io/imod-python/"
Repository = "https://github.com/Deltares/imod-python.git"
"Bug Tracker" = "https://github.com/Deltares/imod-python/issues"
Changelog = "https://github.com/Deltares/imod-python/blob/master/docs/api/changelog.rst"

[project.optional-dependencies]
all = [
    "bottleneck",
    "contextily >=1",
    "cytoolz",
    "geopandas",
    "pyvista",
    "rasterio >=1",
    "rioxarray",
    "shapely >=1.8",
    "zarr",
]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
]

[tool.ruff.lint]
select = ["C4", "E", "F", "I", "NPY201", "PD"]
ignore = [
    "E501", # line-too-long. This rule can't be fullfilled by the ruff formatter. The same behavior as black.
    "PD003",
    "PD004",
    "PD011",
    "PD013",
    "PD015",
]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.ruff.lint.per-file-ignores]
"./docs/conf.py" = ["F401"]
"__init__.py" = ["F401"]
"conftest.py" = ["F401"]
"test_examples.py" = ["F401"]
"examples/*" = ["E402"]

[tool.mypy]
packages = ["imod"]
follow_imports = "normal"
strict = true

# These next few are various gradations of forcing use of type annotations
disallow_untyped_calls = false
disallow_incomplete_defs = false
disallow_untyped_defs = false

# This one isn't too hard to get passing, but return on investment is lower
no_implicit_reexport = false

# This one can be tricky to get passing if you use a lot of untyped libraries
warn_return_any = false

# Define folders that we want to ignore from analyses.
# By defining it at explicit overrides instead of a list of excludes it also 
# works with the vscode mypy extension
[[tool.mypy.overrides]]
module = [
    "imod.common.*",
    "imod.data.*",
    "imod.evaluate.*",
    "imod.formats.*",
    "imod.schemata.*",
    "imod.templates.*",
    "imod.tests.*",
    "imod.visualize.*",
    "imod.wq.*",
]
ignore_errors = true

[[tool.mypy.overrides]]
module = ["imod.msw.*"]
check_untyped_defs = false

# pyvista triggers a mypy daemon crash (mypy bug with partial types)
[[tool.mypy.overrides]]
module = ["pyvista.*"]
follow_imports = "skip"

[[tool.mypy.overrides]]
module = [
    # No stubs available
    "affine.*",
    "cftime.*",
    "numba.*",
    "osgeo.*",
    "rasterio.*",
    "xugrid.*",
    # Stubs available, but too much work to fix right now
    "dateutil.*",
    "geopandas.*",
    "pandas.*",
    "scipy.*",
    "shapely.*",
]
ignore_missing_imports = true

[tool.pytest.ini_options]
markers = [
    "example: marks test as example (deselect with '-m \"not example\"')",
    "user_acceptance: marks user acceptance tests (deselect with '-m \"not user_acceptance\"')",
    "unittest_jit: marks unit tests that should be jitted (deselect with '-m \"not unittest_jit\"')",
    "qgis_export: marks tests that export to QGIS (deselect with '-m \"not qgis_export\"')",
]

[tool.hatch.version]
path = "imod/__init__.py"

[tool.hatch.build.targets.sdist]
only-include = ["imod"]