MHKiT-Python/pyproject.toml at develop · jmcvey3/MHKiT-Python · 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "mhkit"
# `version` is read from `[tools.setuptools.dynamic] version` during build: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata
dynamic = ["version"]
description = "Marine and Hydrokinetic Toolkit"
readme = "README.md"
authors = [
    {name = "MHKiT developers"}
]
license = {text = "Revised BSD"}
classifiers = [
    "Development Status :: 3 - Alpha",
    "Programming Language :: Python :: 3",
    "Topic :: Scientific/Engineering",
    "Intended Audience :: Science/Research",
    "Operating System :: OS Independent",
]
requires-python = ">=3.10"
dependencies = [
    # MHKiT-Python uses xarray everywhere, which leverages netcdf and h5 behind the
    # scenes. xarray, netcdf4, and h5 dependencies should all be synced to avoid
    # compatibility issues with individual modules.
    "xarray>=2024.6.0",
    "netCDF4>=1.7.1.post1",
    "h5py>=3.11.0",
    "h5pyd>=0.18.0",
    "numpy>=2.0.0",
    "pandas>=2.2.2,<3.0",
    "scipy>=1.14.0",
    "matplotlib>=3.9.1",
    "pecos>=0.3.0",
    "requests",
]

[project.optional-dependencies]
# Core dependencies for each module
wave = [
    "scikit-learn>=1.5.1",
    "statsmodels>=0.14.2",
    "pytz",
    "NREL-rex>=0.2.63",
    "beautifulsoup4",
    "bottleneck",
    "lxml",
]

tidal = [
    "bottleneck",
]

river = [
    "bottleneck",
]

dolfyn = [
    "cartopy",
]

power = [
]

loads = [
    "fatpack",
    "statsmodels>=0.14.2",
    "scikit-learn>=1.5.1",
]

mooring = [
]

acoustics = [

]

qc = [

]

utils = [

]

# Development dependencies
dev = [
    "pytest",
    "pylint",
    "pytest-cov",
    "pre-commit",
    "coverage",
    "coveralls",
    "black",
]

# Install all optional dependencies
all = [
    "mhkit[wave]",
    "mhkit[tidal]",
    "mhkit[river]",
    "mhkit[dolfyn]",
    "mhkit[power]",
    "mhkit[loads]",
    "mhkit[mooring]",
    "mhkit[acoustics]",
    "mhkit[qc]",
    "mhkit[utils]",
]

# Examples dependencies
examples = [
    "jupyter",
    "notebook",
    "ipykernel",
    "nbval",
    "utm",
    "folium",
    "mhkit[all]",
]

[project.urls]
Homepage = "https://github.com/MHKiT-Software/mhkit-python"
Documentation = "https://mhkit-software.github.io/MHKiT"

[tool.setuptools.packages.find]
# This section controls how this python package is built for pip installations
# Getting this section wrong results in an incomplete package that is missing submodules
# This can be tested by simply running python -m build in the root directory
# and then inspecting the generated .tar.gz and .whl files in the dist/ directory
#
# https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#finding-simple-packages
# What this does: (per the above docs):
# - `where = ["."]`: Search for packages starting from the root directory
# - `include = ["mhkit*"]`: Only include packages that match the pattern `mhkit*`
#     - this includes `mhkit`, `mhkit.wave`, `mhkit.river`, etc.
# - Setuptools will automatically discover all directories containing `__init__.py` files
where = ["."]
include = ["mhkit*"]

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

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

[tool.pytest.ini_options]
asyncio_default_fixture_loop_scope = "function"