Tools for running and analysing UCLA-ROMS simulations
Project description
ROMS-Tools
Overview
A suite of python tools for setting up a ROMS simulation.
DISCLAIMER: This project is ALPHA and will be EXPERIMENTAL at least throughout Fall 2024. We do not recommend to use this software before this ALPHA development and test phase is completed.
Installation
Installation from conda forge
conda install -c conda-forge roms-tools
This command installs ROMS-Tools
along with its dask
dependency.
Installation from pip
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]
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 romstools-test
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]
Run the tests
Before running the tests, you can activate the conda environment created in the previous section:
conda activate romstools-test
Check the installation of ROMS-Tools
has worked by running the test suite
cd roms-tools
pytest
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 details
Release history Release notifications | RSS feed
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
Hashes for roms_tools-1.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d50aa1df1d4365c61ce1330c72d60932d205922e889c324832b3ff2c5a58669a |
|
MD5 | a8912ec2524a8a76b0a2981821f5afc2 |
|
BLAKE2b-256 | 9d0d178b785e797a71614e7b737b11ea36a816252a04df53856bfaad27e20409 |