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
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)
You can also install ROMS-Tools from pip:
pip install roms-tools
If you want to use ROMS-Tools with dask (recommended for parallel and out-of-core computation), install it with the additional dependency:
pip install roms-tools[dask]
If you want to use ROMS-Tools with dask and 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-with-xesmf.yml
conda activate romstools-test
Finally, install ROMS-Tools in the same environment:
pip install -e .
If you want to use ROMS-Tools with dask (recommended for parallel and out-of-core computation), you can
install ROMS-Tools along with the additional dependency via:
pip install -e ".[dask]"
If you want to use ROMS-Tools with dask and 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 ".[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
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file roms_tools-3.7.0.tar.gz.
File metadata
- Download URL: roms_tools-3.7.0.tar.gz
- Upload date:
- Size: 28.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
62d62e98a4326a2427d024e66d8bf3158ed5b2615185f9cf56f457ad3368c7af
|
|
| MD5 |
81bac54ce6e3f49dbd55aca7e04807bb
|
|
| BLAKE2b-256 |
f5c9d836c3c44f272334e0540e52da6a6353a3aa33056d6c5f544305371785be
|
Provenance
The following attestation bundles were made for roms_tools-3.7.0.tar.gz:
Publisher:
pypipublish.yaml on CWorthy-ocean/roms-tools
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
roms_tools-3.7.0.tar.gz -
Subject digest:
62d62e98a4326a2427d024e66d8bf3158ed5b2615185f9cf56f457ad3368c7af - Sigstore transparency entry: 2227623190
- Sigstore integration time:
-
Permalink:
CWorthy-ocean/roms-tools@c7d9c4f87130bb81f50416cea22abcc2e3b1468c -
Branch / Tag:
refs/tags/v3.7.0 - Owner: https://github.com/CWorthy-ocean
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypipublish.yaml@c7d9c4f87130bb81f50416cea22abcc2e3b1468c -
Trigger Event:
release
-
Statement type:
File details
Details for the file roms_tools-3.7.0-py3-none-any.whl.
File metadata
- Download URL: roms_tools-3.7.0-py3-none-any.whl
- Upload date:
- Size: 984.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82e49323a63af5970ef6806bc81d23f78db3421373c6802d13ab296b97da97d9
|
|
| MD5 |
54d3f75a683d27cfebecde6d05f4f6ac
|
|
| BLAKE2b-256 |
fd17b49c770d8c5c765f1efb5bc395423747ad4e4bf7a3a85994a74690cf5f32
|
Provenance
The following attestation bundles were made for roms_tools-3.7.0-py3-none-any.whl:
Publisher:
pypipublish.yaml on CWorthy-ocean/roms-tools
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
roms_tools-3.7.0-py3-none-any.whl -
Subject digest:
82e49323a63af5970ef6806bc81d23f78db3421373c6802d13ab296b97da97d9 - Sigstore transparency entry: 2227623303
- Sigstore integration time:
-
Permalink:
CWorthy-ocean/roms-tools@c7d9c4f87130bb81f50416cea22abcc2e3b1468c -
Branch / Tag:
refs/tags/v3.7.0 - Owner: https://github.com/CWorthy-ocean
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypipublish.yaml@c7d9c4f87130bb81f50416cea22abcc2e3b1468c -
Trigger Event:
release
-
Statement type:
