pyproject.toml

[build-system]
requires = ["setuptools>=64.0.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "nlmod"
dynamic = ["version"]
description = "Python package to build, run and visualize MODFLOW 6 groundwater models in the Netherlands."
license = { file = "LICENSE" }
readme = "README.md"
authors = [
    { name = "O.N. Ebbens" },
    { name = "R.J. Caljé" },
    { name = "D.A. Brakenhoff" },
]
maintainers = [
    { name = "O.N. Ebbens", email = "o.ebbens@artesia-water.nl" },
    { name = "R.J. Calje", email = "r.calje@artesia-water.nl" },
    { name = "D.A. Brakenhoff", email = "d.brakenhoff@artesia-water.nl" },
]
requires-python = ">= 3.11"
dependencies = [
    "flopy @ git+https://github.com/modflowpy/flopy.git@develop", # HFB utility from flopy#2745, to be released in flopy>3.10.0
    "xarray>=0.16.1",
    "netcdf4>=1.7.2",
    "rasterio>=1.1.0",
    "rioxarray",
    "affine>=0.3.1",
    "geopandas",
    "shapely>=2.0.0",
    "matplotlib",
    "dask",
    "requests",
    "scipy",
    "bottleneck",
]
keywords = ["hydrology", "groundwater", "modeling", "MODFLOW", "flopy"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Other Audience",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Hydrology",
]

[project.urls]
homepage = "https://github.com/gwmod/nlmod"
repository = "https://github.com/gwmod/nlmod"
documentation = "https://nlmod.readthedocs.io/en/latest/"
installation = "https://pypi.org/project/nlmod/"

[project.optional-dependencies]
full = [
    "nlmod[knmi]",
    "geocube",
    "rasterstats",
    "contextily",
    "scikit-image",
    "py7zr",
    "joblib",
    "tqdm",
    "hydropandas>=0.9.2",
    "owslib>=0.24.1",
    "pyshp>=2.1.3",
    "numba",
]
knmi = ["h5netcdf", "h5py", "nlmod[grib]"]
grib = ["cfgrib"]
test = ["pytest>=7", "pytest-cov", "lxml"]
nbtest = ["nbformat", "nbconvert>6.4.5", "openpyxl"]
lint = ["ruff"]
ci = ["nlmod[full,lint,test,nbtest]"]
rtd = [
    "nlmod[full]",
    "ipython",
    "ipykernel",
    "ipywidgets",
    "myst-nb",
    "sphinx_rtd_theme",
    "nbconvert",
    "openpyxl",
]
lgn = ["xarray-spatial", "exactextract"]

[tool.setuptools.dynamic]
version = { attr = "nlmod.version.__version__" }

[tool.setuptools.packages.find]
where = ["."]

[tool.setuptools]
include-package-data = true

[tool.setuptools.package-data]
"nlmod.data" = ["*.gleg"]
"nlmod.data.geotop" = ["*"]
"nlmod.data.regis" = ["*"]
"nlmod.data.shapes" = ["*"]
"nlmod.data.ahn" = ["*"]
"nlmod.data.bgt" = ["*"]
"nlmod.data.bofek" = ["*"]
"nlmod.bin" = ["mp7_2_002_provisional"]

[tool.ruff]
line-length = 88
extend-include = ["*.ipynb"]
show-fixes = true
fix = true

[tool.ruff.lint]
select = [
    "C4",  # flake8-comprehensions
    "E",   # pycodestyle
    "F",   # pyflakes
    "I",   # isort
    "PT",  # pytest-style
    "D",   # pydocstyle
    "B",   # flake8-bugbear
    "NPY", # numpy
]
ignore = [
    "D401", # Imperative mood for docstring. Be glad we have docstrings at all :P!
    "D100", # Missing docstring in module.
    "D104", # Missing docstring in public package.
]
extend-select = ["I"]
pydocstyle.convention = "numpy"

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["D103", "D205", "E501", "E722", "PT011", "PT028", "PT030"]
"docs/**" = ["D103", "E402", "E501"]

[tool.pytest.ini_options]
addopts = "--strict-markers --durations=0 --cov-report xml:coverage.xml --cov nlmod -v"
markers = ["notebooks: run notebooks", "slow: slow tests", "skip: skip tests"]