A suite of python tools for setting up a ROMS simulation.
pip install roms-tools
If you want to use ROMS-Tools
together with dask (which we recommend), you can
install ROMS-Tools
along with the additional dependency via:
pip install roms-tools[dask]
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 romstools
Finally, install ROMS-Tools
in the same environment:
pip install -e .
If you want to use ROMS-Tools
together with dask (which we recommend), you can
install ROMS-Tools
along with the additional dependency via:
pip install -e .[dask]
Before running the tests, you can activate the conda environment created in the previous section:
conda activate romstools
Check the installation of ROMS-Tools
has worked by running the test suite
cd roms-tools
pytest
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.