BlueMath_tk/pyproject.toml at develop · GeoOcean/BlueMath_tk · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
[build-system]
requires = ["setuptools>=60", "setuptools-scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "bluemath-tk"
description = "Module collection for custom climate data analysis. The main objective of this Python package is to provide a set of statistical tools tailored for climate data analysis, with a focus on statistical classification and prediction."
readme = "README.md"
keywords = ["climate", "statistical", "tools"]
license = { file = "LICENSE" }
authors = [
    { name = "Geomatics and Ocean Engineering Group", email = "bluemath@unican.es" },
]
dynamic = ["version"]
requires-python = ">=3.11"
classifiers = [
    "Programming Language :: Python :: 3 :: Only",
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
]
dependencies = [
    "requests",
    "numpy",
    "pandas",
    "xarray",
    "netcdf4",
    "dask",
    "distributed",
    "zarr",
    "scipy",
    "scikit-learn",
    "pyclustering",
    "matplotlib",
    "cartopy",
    "jinja2",
    "aiohttp",
    "minisom",
    "statsmodels",
    "regionmask",
    "ipykernel",
    "ipywidgets",
    "cmocean",
    "siphon",
    "plotly",
    "h5py",
    "prettytable",
    "numba",
    "csaps",
]

[project.optional-dependencies]
docs = ["sphinx", "sphinx-rtd-theme", "jupyter-sphinx", "myst-parser"]
tests = ["pytest", "ruff"]
downloaders = ["cdsapi", "ecmwf-opendata"]
waves = ["wavespectra", "olas"]
numerical-models = ["hydromt-sfincs"]
deeplearning = ["torch", "gpytorch", "optuna"]
all = [
    "cdsapi",
    "ecmwf-opendata",
    "wavespectra",
    "olas",
    "hydromt-sfincs",
    "torch",
    "gpytorch",
    "optuna",
]

[project.urls]
Homepage = "https://github.com/GeoOcean/BlueMath_tk"
Documentation = "https://geoocean.github.io/BlueMath_tk/"
Issues = "https://github.com/GeoOcean/BlueMath_tk/issues"

[tool.setuptools.packages.find]
where = ["."]
include = ["bluemath_tk*"]

[tool.setuptools_scm]
version_file = "bluemath_tk/_version.py"
local_scheme = "no-local-version"

[tool.ruff]
line-length = 88
target-version = "py311"

[tool.ruff.lint]
# Select rules to check
select = [
    "E",  # pycodestyle errors
    "F",  # pyflakes
    "W",  # pycodestyle warnings
    "D",  # pydocstyle (docstring checking)
    "I",  # isort (import sorting)
    "N",  # pep8-naming
    "UP", # pyupgrade
]
# Ignore some docstring rules (start lenient, tighten later)
# Focus on missing docstrings first, style issues can be auto-fixed later
ignore = [
    # "D100", # Missing docstring in public module
    # "D104", # Missing docstring in public package
    # "D107", # Missing docstring in __init__
    # "D203", # 1 blank line required before class docstring
    # "D213", # Multi-line docstring summary should start at the second line
    # "D401", # First line should be in imperative mood (can be strict)
    "D202", # No blank lines allowed after docstring (auto-fixable)
    # "D300", # Use """triple double quotes""" (auto-fixable)
    "D400", # First line should end with a period (can fix gradually)
    "D200", # One-line docstring should fit on one line (auto-fixable)
    # "D403", # First word of the first line should be capitalized (auto-fixable)
    # "D404", # First word of the docstring should not be This (auto-fixable)
    # "D409", # Section underline length mismatch (auto-fixable)
    # "D411", # No blank line before section (auto-fixable)
    # "D410", # No blank line after section (auto-fixable)
    # "D407", # Missing dashed underline after section (auto-fixable)
    # "D405", # Section name should be properly capitalized (auto-fixable)
    # "D210", # No whitespace allowed surrounding docstring summary (auto-fixable)
    # "D406", # Missing newline after section name (auto-fixable)
    # "D201", # No blank lines allowed before function docstring (auto-fixable)
    # "D204", # 1 blank line required after class docstring (auto-fixable)
    # "D206", # Docstring should be indented with spaces, not tabs (auto-fixable)
    "D205", # 1 blank line required between summary line and description (auto-fixable)
    # "D419", # Empty docstring (rare, can fix manually)
    "N802", # Use "f" prefix for string formatting
    "N803", # Use "f" prefix for string formatting
    "N806", # Use f-string for string formatting
]

[tool.ruff.lint.pydocstyle]
convention = "numpy" # Use NumPy convention

[tool.ruff.lint.per-file-ignores]
# Ignore docstring requirements in tests
"tests/*" = ["D103"] # Missing docstring in public function