Tools for running and analysing UCLA-ROMS simulations
Project description
ROMS-Tools
Overview
A suite of python tools for setting up a ROMS simulation.
Installation instructions
Installation from pip
pip install roms-tools
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
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 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
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.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 400f9ac040aa176bfed1dc7d80bf284389f0c8cb3bedeefde8c0d9729f687bd6 |
|
MD5 | 5133b0d87c1678310d0b36dd673947a9 |
|
BLAKE2b-256 | 6b62191b648e516f38ca3ba60df81f6d2b2fab29c6645cc08e9018f1cfb85b5b |