From 316069741d922e566dcc0f56e0cb8be0833dd629 Mon Sep 17 00:00:00 2001 From: martinvonk Date: Thu, 7 Aug 2025 12:41:10 +0200 Subject: [PATCH 1/5] cleanup pyproject.toml --- pyproject.toml | 66 +++++++++++++++++++------------------------------- 1 file changed, 25 insertions(+), 41 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 7338de27..924a7317 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,20 +2,23 @@ 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. Ebbens" }, { name = "R. Caljé" }, { name = "D.A. Brakenhoff" }] +authors = [ + { name = "O. Ebbens" }, + { name = "R. Caljé" }, + { name = "D.A. Brakenhoff" }, +] maintainers = [ { name = "O. Ebbens", email = "o.ebbens@artesia-water.nl" }, { name = "R. Calje", email = "r.calje@artesia-water.nl" }, { name = "D.A. Brakenhoff", email = "d.brakenhoff@artesia-water.nl" }, ] -requires-python = ">= 3.8" +requires-python = ">= 3.10" dependencies = [ "flopy>=3.3.6", "xarray>=0.16.1", @@ -34,23 +37,25 @@ dependencies = [ "joblib", "bottleneck", ] -keywords = ["hydrology", "groundwater", "modeling", "Modflow 6", "flopy"] +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.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Topic :: Scientific/Engineering :: Hydrology', + "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 = [ @@ -66,7 +71,7 @@ knmi = ["h5netcdf", "nlmod[grib]"] grib = ["cfgrib", "ecmwflibs"] test = ["pytest>=7", "pytest-cov", "pytest-dependency"] nbtest = ["nbformat", "nbconvert>6.4.5"] -lint = ["flake8", "isort", "black[jupyter]"] +lint = ["ruff"] ci = ["nlmod[full,lint,test,nbtest]", "numpy==1.26.4"] rtd = [ "nlmod[full]", @@ -100,38 +105,17 @@ include-package-data = true "nlmod.data.bofek" = ["*"] "nlmod.bin" = ["mp7_2_002_provisional"] -[tool.black] -line-length = 88 - -[tool.isort] -profile = "black" - [tool.ruff] line-length = 88 extend-include = ["*.ipynb"] +show-fixes = true +fix = true [tool.ruff.lint] -# See: https://docs.astral.sh/ruff/rules/ -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. -] - -[tool.ruff.format] - -[tool.ruff.lint.pydocstyle] -convention = "numpy" +select = ["C4", "E", "F", "I", "PT", "D", "B", "NPY"] +extend-select = ["I"] +ignore = ["D401", "D100", "D104"] +pydocstyle.convention = "numpy" [tool.pytest.ini_options] addopts = "--strict-markers --durations=0 --cov-report xml:coverage.xml --cov nlmod -v" From 2d4cc1b3103ce65428b0d0598ca6ed2d970ffb47 Mon Sep 17 00:00:00 2001 From: martinvonk Date: Thu, 7 Aug 2025 12:41:41 +0200 Subject: [PATCH 2/5] update year --- LICENSE | 2 +- docs/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 981f1163..c92d3212 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2024 O.N. Ebbens, D.A. Brakenhoff, R. Calje +Copyright (c) 2025 O.N. Ebbens, D.A. Brakenhoff, R. Calje Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/conf.py b/docs/conf.py index 9ba77845..f2d506d4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ # -- Project information ----------------------------------------------------- project = "nlmod" -copyright = "2024, O.N. Ebbens, D.A. Brakenhoff, R. Caljé" +copyright = "2025, O.N. Ebbens, D.A. Brakenhoff, R. Caljé" author = "O.N. Ebbens, D.A. Brakenhoff, R. Caljé" # The short X.Y version From 37b1ed9bacfc9a78d6f0b03f5efa6dc5d2fe4bf9 Mon Sep 17 00:00:00 2001 From: martinvonk Date: Thu, 7 Aug 2025 12:43:10 +0200 Subject: [PATCH 3/5] add comments back --- pyproject.toml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 924a7317..83d1e163 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -112,9 +112,22 @@ show-fixes = true fix = true [tool.ruff.lint] -select = ["C4", "E", "F", "I", "PT", "D", "B", "NPY"] +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"] -ignore = ["D401", "D100", "D104"] pydocstyle.convention = "numpy" [tool.pytest.ini_options] From 94d12bb9ffea04202808974c7bd4fd42579125fa Mon Sep 17 00:00:00 2001 From: OnnoEbbens Date: Thu, 7 Aug 2025 14:31:58 +0200 Subject: [PATCH 4/5] Update pyproject.toml --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 83d1e163..ef032897 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ description = "Python package to build, run and visualize MODFLOW 6 groundwater license = { file = "LICENSE" } readme = "README.md" authors = [ - { name = "O. Ebbens" }, + { name = "O.N. Ebbens" }, { name = "R. Caljé" }, { name = "D.A. Brakenhoff" }, ] From 0bf4bbcc748e0d532b5fce5b4a504a92716fa731 Mon Sep 17 00:00:00 2001 From: OnnoEbbens Date: Thu, 7 Aug 2025 14:32:06 +0200 Subject: [PATCH 5/5] Update pyproject.toml --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index ef032897..6b98bf6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ authors = [ { name = "D.A. Brakenhoff" }, ] maintainers = [ - { name = "O. Ebbens", email = "o.ebbens@artesia-water.nl" }, + { name = "O.N. Ebbens", email = "o.ebbens@artesia-water.nl" }, { name = "R. Calje", email = "r.calje@artesia-water.nl" }, { name = "D.A. Brakenhoff", email = "d.brakenhoff@artesia-water.nl" }, ]