timflow/pyproject.toml at main · timflow-org/timflow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "timflow"
description = "Analytic element modeling of groundwater flow"
readme = "README.md"
license = { file = "LICENSE" }
authors = [{ name = "Mark Bakker" }, { name = "Davíd Brakenhoff" }]
maintainers = [
    { name = "Mark Bakker", email = "markbak@gmail.com" },
    { name = "Davíd Brakenhoff", email = "d.brakenhoff@artesia-water.nl" },
]
dynamic = ["version"]
keywords = ["hydrology", "groundwater", "model", "analytic element method"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Other Audience",
    "License :: OSI Approved :: MIT License",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX",
    "Operating System :: Unix",
    "Operating System :: MacOS",
    "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 :: 3 :: Only",
    "Topic :: Scientific/Engineering :: Hydrology",
]
requires-python = ">=3.11"
dependencies = ["numpy", "scipy", "numba", "matplotlib", "pandas"]

[project.urls]
homepage = "https://github.com/timflow-org/timflow"
repository = "https://github.com/timflow-org/timflow"
documentation = "https://timflow.readthedocs.io/en/latest/"

[project.optional-dependencies]
lint = ["ruff"]
optional = ["lmfit"]
ci = ["timflow[lint,optional]", "pytest", "pytest-cov", "pytest-xdist", "nbval", "jupyter", "shapely",]
docs = [
    "timflow[ci]",
    "sphinx",
    "sphinx-design",
    "pydata-sphinx-theme",
    "numpydoc",
    "myst_nb",
    "sphinxcontrib-bibtex",
    "sphinx-autoapi",
]
dev = ["timflow[docs]"]

[tool.setuptools.packages]
find = {}

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

[tool.ruff]
line-length = 90
extend-include = ["*.ipynb"]

[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 = [
    "D100", # Missing docstring in public module
    "D101", # Missing docstring in public class
    "D102", # Missing docstring in public method
    "D103", # Missing docstring in public function
    "D105", # Missing docstring in magic method
    "D401", # First line should be in imperative mood
    "B006", # Do not use mutable data structures as default arguments
]

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

[tool.pytest.ini_options]
addopts = [
    "--durations=20",
    "--cov=timflow",
    "--cov-report=term",
    "--cov-report=lcov:./coverage/lcov.info",
    "--ignore=docs/steady/02examples/vertical_anisotropy.ipynb",
    "--ignore=docs/steady/04benchmarks/benchmarking_besselaes.ipynb",
]
markers = [
    "notebooks: run notebooks",
]

[tool.coverage.run]
omit = [
    "*/steady/besselaesnumba/besselaesnumba_old.py",
    "*/steady/circinhom.py",
    "*/transient/circinhom.py",
    "*/transient/besselnumba_total.py",
    "*/transient/aquifernew.py",
    "*/transient/kuhlman_invlap.py",
]