ROMS-Tools
Overview
A suite of Python tools for setting up and analyzing a UCLA-ROMS simulation with or without MARBL biogeochemistry.
Installation
⚡️ Installation from conda-forge (recommended)
To install ROMS-Tools with all dependencies, including xesmf, dask and all packages required for streaming source data directly from the cloud, use:
conda install -c conda-forge roms-tools
[!Note] Installation from Conda-Forge is the recommended installation method to ensure all features of
ROMS-Toolsare available.
📦 Installation from PyPI (pip) (recommend for Windows only)
You can also install ROMS-Tools from pip:
pip install roms-tools
dask (recommended for parallel and out-of-core computation) is included by default.
If you want to use ROMS-Tools with all packages required for streaming source data directly from the cloud, install it with the additional dependencies:
pip install roms-tools[stream]
[!Note] The PyPI versions of
ROMS-Toolsdo not includexesmf, so some features will be unavailable.
Installation from GitHub
To obtain the latest development version, first clone the source repository:
git clone https://github.com/CWorthy-ocean/roms-tools.git
cd roms-tools
Next, install and activate the following conda environment:
conda env create -f ci/environment.yml
conda activate roms-tools-env
Finally, install ROMS-Tools in the same environment, along with the dev extra (test/lint tooling):
pip install -e ".[dev]"
dask (recommended for parallel and out-of-core computation) is included in the core dependencies by default.
If you want to use ROMS-Tools with all packages required for streaming source data directly from the cloud, you can
install ROMS-Tools along with the additional dependencies via:
pip install -e ".[dev,stream]"
Getting Started
To learn how to use ROMS-Tools, check out the documentation.
How to cite ROMS-Tools
If you use ROMS-Tools in your work, we would be happy if you cite our paper in the Journal of Open Source Software:
Loose, N., Nicholas, T., Maticka, S., Eilerman, S., McBride, C., Stephenson, D., Heede, U., Saenz, B., Thyng, K. M., Bachman, S., Damien, P., Karspeck, A., Long, M. C., Molemaker, M. J., & Wyatt, A. (2026). ROMS-Tools: Reproducible Preprocessing and Analysis for Regional Ocean Modeling with ROMS. Journal of Open Source Software, 11(124), 10234. https://doi.org/10.21105/joss.10234
Or use the following BibTeX entry:
@article{loose2026romstools,
author = {Loose, Nora and Nicholas, Tom and Maticka, Sam and Eilerman, Scott
and McBride, Christopher and Stephenson, Dafydd and Heede, Ulla
and Saenz, Benjamin and Thyng, Kristen M. and Bachman, Scott
and Damien, Pierre and Karspeck, Alicia and Long, Matthew C.
and Molemaker, M. Jeroen and Wyatt, Abigale},
title = {{ROMS-Tools}: Reproducible Preprocessing and Analysis for
Regional Ocean Modeling with {ROMS}},
journal = {Journal of Open Source Software},
year = {2026},
volume = {11},
number = {124},
pages = {10234},
doi = {10.21105/joss.10234},
url = {https://joss.theoj.org/papers/10.21105/joss.10234},
}
Feedback and contributions
If you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.
We also accept contributions in the form of Pull Requests.
See also
3 maintainers
Release files for roms-tools 5.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| roms_tools-5.0.0.tar.gz | 28.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| roms_tools-5.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.4 MB
Release files / roms_tools-5.0.0.tar.gz
| Download URL | roms_tools-5.0.0.tar.gz |
|---|---|
| Size | 28.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
409ba20f7f0f83516405053cb46e033095c1c94ae3ea43d1da5d8be9649236a4
|
|
BLAKE2b-256 checksum How to use checksums |
4b947f20f2797e94fc8f41dc187721365c40a426ee4def664c3d56517d5871b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / roms_tools-5.0.0-py3-none-any.whl
| Download URL | roms_tools-5.0.0-py3-none-any.whl |
|---|---|
| Size | 352.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
efc5f3ec35f25b8031f17dca4067f71da425d1e357fb9d5c4d25d192066bda26
|
|
BLAKE2b-256 checksum How to use checksums |
cfd079a6956e55469275bc11046219618d8367f0c22b7654cf3aedac142fef36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency log
