hydrogym/pyproject.toml at main · dynamicslab/hydrogym · 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
[tool.poetry]
name = "hydrogym"
version = "1.0.0"
authors = [
    "HydroGym Team"
]
maintainers = [
    "Christian Lagemann <clage@uw.edu>",
    "Ludger Paehler <paehlerludger@gmail.com>",
    "Jared Callaham <jared.callaham@gmail.com>",
]
description = "A Reinforcement Learning Benchmarking Environment for Fluid Dynamics (with Firedrake, JAX-Fluids, MAIA, and NEK5000 solver support)"
license = "MIT"
readme = "README.md"
classifiers=[
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Operating System :: MacOS",
    "Operating System :: Unix",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Scientific/Engineering :: Atmospheric Science",
    "Topic :: Scientific/Engineering :: Hydrology",
    "Topic :: Scientific/Engineering :: Physics",
]
documentation = "https://dynamicslab.github.io/hydrogym"
repository = "https://github.com/dynamicslab/hydrogym"
keywords = [
    "Reinforcement Learning",
    "Scientific Machine Learning",
    "Benchmarking",
    "Computational Fluid Dynamics"
]
include = [
    { path = "hydrogym"}
]

[tool.poetry.urls]
issues = "https://github.com/dynamicslab/hydrogym/issues"

[tool.poetry.dependencies]
python = "^3.10"

# Core dependencies
control = "^0.9.2"
dmsuite = "^0.1.1"
gymnasium = "^1.2.3"
huggingface-hub = "^0.16.0"
pandas = "^2.1.0"
scipy = "^1.7.0"

# Firedrake solver optional dependencies
# (firedrake itself must be installed via its own installer)
gmsh = { version = "^4.11.1", optional = true }
psutil = {version = "^7.2.2", optional = true }

# Maia solver optional dependencies
mpi4py = { version = "^4.0.0", optional = true }
omegaconf = { version = "^2.1.0", optional = true }
einops = { version = "^0.6.0", optional = true }
toml = { version = "^0.10.0", optional = true }

# NEK5000 solver optional dependencies
pymech = { version = "^1.4.0", optional = true }
pettingzoo = { version = "^1.24.0", optional = true }
stable-baselines3 = { version = "^2.7.1", optional = true }
supersuit = { version = "3.10.0", optional = true }
tensorboard = { version = "^2.0.0", optional = true }

# JAX solver optional dependencies
jax = { version = "*", optional = true }
jaxlib = { version = "*", optional = true }
chex = { version = "*", optional = true }
navix = { version = "*", optional = true }
gymnax = { version = "*", optional = true }
tree-math = { version = "*", optional = true }

# JAX-Fluids solver optional dependencies
flax = { version = "*", optional = true }
gitpython = { version = "*", optional = true }
h5py = { version = "*", optional = true }
optax = { version = "*", optional = true }
pyvista = { version = "*", optional = true }


[tool.poetry.extras]
firedrake = ["gmsh", "psutil"]
maia = ["mpi4py", "omegaconf", "einops", "toml"]
nek = ["mpi4py", "omegaconf", "pymech", "pettingzoo", "stable-baselines3", "supersuit", "tensorboard"]
jax = ["jax", "jaxlib", "chex", "navix", "gymnax", "tree-math", "flax", "omegaconf", "toml"]
jaxfluids = ["jax", "jaxlib", "flax", "gitpython", "h5py", "optax"]
all = [
  "gmsh", "psutil",
  "mpi4py", "omegaconf", "einops", "toml",
  "pymech", "pettingzoo", "stable-baselines3", "supersuit", "tensorboard",
  "jax", "jaxlib", "chex", "navix", "gymnax", "tree-math",
  "flax", "gitpython", "h5py", "optax"
]

[tool.poetry.group.dev.dependencies]
ruff = "^0.15.8"
isort = "^5.13.0"
toml = "^0.10.2"
tomli = "^2.0.1"
codespell = "^2.2.6"
pytest = "^8.1.1"
psutil = "^7.0.2"

[tool.poetry.group.interactive.dependencies]
jupyterlab = "^3.5.2"
ipykernel = "^6.19.4"
notebook = "^6.5.2"
ipywidgets = "^8.0.4"
mpltools = "^0.2.0"
nbformat = "^5.7.1"
nbconvert = "^7.2.7"
memory-profiler = "^0.61.0"
seaborn = "^0.12.1"

[tool.ruff]
line-length = 120

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
line-ending = "lf"
skip-magic-trailing-comma = false

[tool.ruff.lint]
select = ["E", "F"]
ignore = ["F401", "E731"]

[tool.isort]
profile = "black"
line_length = 120
known_first_party = ["hydrogym"]

[tool.codespell]
skip = '*.svg,*.ipynb,./docs/package-lock.json'

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"