A suite of Python tools for setting up and analyzing a UCLA-ROMS simulation with or without MARBL biogeochemistry.
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-toolsNote
Installation from Conda-Forge is the recommended installation method to ensure all features of ROMS-Tools are available.
You can also install ROMS-Tools from pip:
pip install roms-toolsIf 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-Tools do not include xesmf, so some features will be unavailable.
To obtain the latest development version, first clone the source repository:
git clone https://github.com/CWorthy-ocean/roms-tools.git
cd roms-toolsNext, install and activate the following conda environment:
conda env create -f ci/environment-with-xesmf.yml
conda activate romstools-testFinally, 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]"To learn how to use ROMS-Tools, check out the documentation.
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.