ROMS-Tools

Conda version PyPI version Run Tests codecov Documentation Status Supported Python Versions PyPI Downloads

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-Tools are 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-Tools do not include xesmf, 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.

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

Project links

Data verified by PyPI on Aug 7, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (4.1.1)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for ankona from gravatar.com ankona Avatar for NoraLoose from gravatar.com NoraLoose Avatar for TomNicholas from gravatar.com TomNicholas

Credits

Author: Nora Loose

GitHub Statistics

Data verified by PyPI on Aug 7, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache-2)

Requires

Python >=3.12

Provides Extra

stream movie notebooks dev docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roms_tools-4.0.1.tar.gz (28.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

roms_tools-4.0.1-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file roms_tools-4.0.1.tar.gz.

File metadata

  • Download URL: roms_tools-4.0.1.tar.gz
  • Upload date:
  • Size: 28.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for roms_tools-4.0.1.tar.gz
Algorithm Hash digest
SHA256 b5b77dc8650c245ab36ac9f23ce54a74f777da0b0eacb7c53f9825dd40035bbe
MD5 303f796bc85f251c089a0edf2bb80af7
BLAKE2b-256 b67365509c2746fa01feb6bf33cc61f0a90ed6d3df8becfa150eeeae5e9b74c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for roms_tools-4.0.1.tar.gz:

Publisher: pypipublish.yaml on CWorthy-ocean/roms-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file roms_tools-4.0.1-py3-none-any.whl.

File metadata

  • Download URL: roms_tools-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for roms_tools-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dcee1ceb263e4a52c2e837f2c2ffac9317c42d8c35fd1c2441258d0b63795ee4
MD5 fad7aa0539925e156f912446bb6bcb87
BLAKE2b-256 c62c4f030614a9a9d94507ba3816097c4cdc1d9fb35d79de237f14a68a232c8e

See more details on using hashes here.

Provenance

The following attestation bundles were made for roms_tools-4.0.1-py3-none-any.whl:

Publisher: pypipublish.yaml on CWorthy-ocean/roms-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

4.1.1

2 files

4.1.0

2 files

This release

4.0.1 This release

2 files

4.0.0

2 files

Pre-release

4.0.0a2

2 files

Pre-release

4.0.0a1

2 files

3.7.0

2 files

3.6.0

2 files

3.5.0

2 files

3.4.0

2 files

3.3.0

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.7.0

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.0

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.7.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.0

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.20

2 files

0.1.0

2 files

0.0.6

2 files

0.0.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page