pyproject.toml

[build-system]
requires = ["setuptools >=61"]
build-backend = "setuptools.build_meta"

[project]
name = "flopy4"
description = "Development project to reimplement MF6 support for FloPy"
authors = [
    { name = "Joe Hughes", email = "jdhughes@usgs.gov" },
    { name = "Chris Langevin", email = "langevin@usgs.gov" },
    { name = "Josh Larsen", email = "jlarsen@usgs.gov" },
    { name = "Michael Reno", email = "mreno@ucar.edu" },
    { name = "Wes Bonelli", email = "wbonelli@ucar.edu" },
    { name = "Marnix Kraus", email = "Marnix.Kraus@deltares.nl" },
]
maintainers = [
    { name = "Joe Hughes", email = "jdhughes@usgs.gov" },
    { name = "Chris Langevin", email = "langevin@usgs.gov" },
    { name = "Josh Larsen", email = "jlarsen@usgs.gov" },
    { name = "Michael Reno", email = "mreno@ucar.edu" },
    { name = "Wes Bonelli", email = "wbonelli@ucar.edu" },
]
keywords = ["MODFLOW", "groundwater", "hydrogeology"]
license = { text = "CC0" }
classifiers = [
    "Development Status :: 1 - Planning",
    "Intended Audience :: Science/Research",
    "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Hydrology",
]
requires-python = ">=3.11,<3.14"
dependencies = [
    "modflow-devtools[ecosystem] @ git+https://github.com/MODFLOW-ORG/modflow-devtools.git",
    "xattree @ git+https://github.com/wpbonelli/xattree.git",
    "attrs>=25.4.0,<26",
    "cattrs>=25.3.0,<26",
    "flopy>=3.9.5,<4",
    "jinja2>=3.1.6,<4",
    "lark>=1.3.1,<2",
    "numpy>=2.3.4,<3",
    "pandas>=2.3.3",
    "pydantic",
    "xugrid==0.14.3",
    "scipy>=1.16.2,<2",
    "sparse>=0.17.0",
]
dynamic = ["version"]

[project.optional-dependencies]
optional = [
    "xarray[parallel,io]>=2025.10.1,<2026",
    "dask[array]>=2025.10.0,<2026",
    "pyproj>=3.7.2,<4",
    "networkx>=3.5,<4",
    "pyshp>=3.0.2.post1,<4",
]
dev = ["flopy4[optional,lint,test,build]"]
lint = ["codespell[toml] >=2.2.2", "ruff", "pre-commit>=4.0.1,<5", "mypy"]
test = [
    "coverage",
    "GitPython",
    "jupyter",
    "jupytext",
    "pooch>=1.8",
    "pytest!=8.1.0",
    "pytest-dotenv",
    "pytest-xdist",
    "pytest-benchmark",
    "pytest-cov",
    "filelock",
]
build = ["build", "twine"]

[tool.setuptools]
include-package-data = true
zip-safe = false

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

[tool.setuptools.packages.find]
include = ["flopy4", "flopy4.*"]

[tool.setuptools.package-data]
"flopy4.dfns" = ["dfns/*.dfn"]
"flopy4.toml" = ["dfns/toml/*.toml"]
"flopy4" = [
    "mf6/codec/**/*.lark",
    "mf6/codec/**/*.jinja",
    "mf6/utils/codegen/templates/*.jinja",
    "mf6/utils/codegen/dfn_overrides.toml",
]

[tool.ruff]
line-length = 100
target-version = "py311"
include = ["pyproject.toml", "flopy4/**/*.py", "test/**/*.py", "docs/**/*.py"]
extend-include = ["docs/**/*.ipynb"]
exclude = ["flopy4/ispec/*.py"]

[tool.ruff.lint]
select = [
    "D409", # pydocstyle - section-underline-matches-section-length
    "E",    # pycodestyle error
    "F",    # Pyflakes
    "I001", # isort - unsorted-imports
]
ignore = [
    "F841", # local variable is assigned to but never used
    "F821", # undefined name TODO FIXME
    "E722", # do not use bare `except`
    "E741", # ambiguous variable name
]

[project.scripts]
flopy4 = "flopy4.cli:main"

[project.entry-points.flopy4]
plot = "flopy4.singledispatch.plot_int"
dfn2lark = "flopy4.mf6.codec.reader.dfn2lark:main"

[tool.pixi.workspace]
channels = ["conda-forge"]
platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]

[tool.pixi.pypi-dependencies]
flopy4 = { path = ".", editable = true, extras = ["optional"] }

[tool.pixi.feature.py311.dependencies]
python = "3.11.*"

[tool.pixi.feature.py312.dependencies]
python = "3.12.*"

[tool.pixi.feature.py313.dependencies]
python = "3.13.*"

[tool.pixi.environments]
test311 = { features = ["py311", "test"], solve-group = "py311" }
test312 = { features = ["py312", "test"], solve-group = "py312" }
test313 = { features = ["py313", "test"], solve-group = "py313" }
dev = { features = ["py311", "test", "lint", "build"], solve-group = "py311" }
docs = { features = ["py311", "docs"], solve-group = "py311" }

[tool.pixi.dependencies]
proj = ">=9.7.0,<10"
netcdf4 = ">=1.7.3,<2"

[tool.pixi.feature.docs.pypi-dependencies]
jupyter-book = ">=1.0,<2"
jupyter = "*"
jupytext = "*"

[tool.pixi.feature.docs.tasks]
build-docs = { cmd = "jupyter-book build docs/" }
update-ghpages = { cmd = "python scripts/update_ghpages.py", description = "Sync and re-execute example notebooks for gh-pages deployment" }

[tool.pixi.feature.build.tasks]
build = { cmd = "python -m build" }

[tool.pixi.tasks.generate-classes]
cmd = "generate-mf6-classes MODFLOW-ORG/modflow6@latest --existing-only --verbose"
description = "Regenerate existing MF6 classes in flopy4/mf6/ from the latest release DFNs"

[tool.pixi.tasks.generate-classes-preview]
cmd = "generate-mf6-classes MODFLOW-ORG/modflow6@latest --outdir ./tmp/mf6-preview --makedirs --verbose"
description = "Generate MF6 classes into ./tmp/mf6-preview (safe preview)"

[tool.pixi.tasks.sync]
cmd = "flopy4 mf6 sync --verbose"
description = "Sync flopy4.mf6 to the discovered or latest MF6 release"

[tool.pixi.tasks.sync-status]
cmd = "flopy4 mf6 status"
description = "Show flopy4.mf6 sync status vs. discovered MF6 binary"

[tool.pixi.feature.test.tasks]
test = { cmd = "pytest -v -n auto", env = { MPLBACKEND = "Agg" } }

[tool.pixi.feature.lint.tasks]
install = { cmd = "pre-commit install --install-hooks" }

[tool.mypy]
mypy_path = "flopy4"
ignore_missing_imports = true
warn_unreachable = true

[tool.codespell]
skip = "pixi.*,./docs/examples/quickstart/*,**/temp/*,./docs/examples/*.ipynb,./docs/_build/*"
ignore-words-list = [
    "wel",
    "nam",
    "coo",
    "datbase",
    "inout",
    "delt",
    "ist",
    "lke",
]


[tool.pytest_env]
MPLBACKEND = "agg"