Metadata-Version: 2.4
Name: zoomy-jax
Version: 0.1.0
Summary: JAX solver backend for the Zoomy simulation framework.
Author-email: Ingo Steldermann <steldermann@mbd.rwth-aachen.de>
License: LGPL-3.0-or-later
Project-URL: Homepage, https://github.com/ZoomyLab/Zoomy
Project-URL: Documentation, https://zoomylab.github.io/Zoomy
Project-URL: Source, https://github.com/ZoomyLab/Zoomy
Project-URL: Issues, https://github.com/ZoomyLab/Zoomy/issues
Keywords: jax,simulation,zoomy,shallow flow,physics,autodiff
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: jax>=0.7.0
Requires-Dist: h5py
Requires-Dist: equinox>=0.13
Requires-Dist: attrs
Requires-Dist: zoomy-core>=0.2.17
Provides-Extra: cuda
Requires-Dist: jax[cuda12]>=0.7.0; extra == "cuda"
Provides-Extra: server
Requires-Dist: zoomy-server; extra == "server"
Provides-Extra: gnn
Requires-Dist: equinox>=0.13; extra == "gnn"
Requires-Dist: optax; extra == "gnn"
Requires-Dist: jraph; extra == "gnn"

# zoomy-jax

JAX solver backend for [Zoomy](https://github.com/ZoomyLab/Zoomy), a simulation
software for dimensionally-reduced free surface flows. It runs the models derived
in [`zoomy-core`](https://pypi.org/project/zoomy-core/) on CPU, GPU and multiple
devices (finite volume, adaptive time stepping, automatic differentiation).

```bash
pip install zoomy-jax            # CPU
pip install "zoomy-jax[cuda]"    # NVIDIA GPU (CUDA 12)
```

Documentation: <https://zoomylab.github.io/Zoomy>

Optional extras: `ad` (reverse-mode AD through the time loop), `gnn` (learned
multigrid experiments), `server`.

License: LGPL-3.0-or-later.
