Tools for running and analysing UCLA-ROMS simulations
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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
File details
Details for the file roms_tools-1.3.0.tar.gz.
File metadata
- Download URL: roms_tools-1.3.0.tar.gz
- Upload date:
- Size: 8.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c9638e1197ea998d6a5414dd3b1807afa86b38c5ad51a5c9dbdfafbf0a42f7a9 |
|
| MD5 | 3b67404cc4260908316527bb64b3a62e |
|
| BLAKE2b-256 | a8a29ef46c4f7504659fa958069e1a39bc3f3d013c43bd3f5d09abc5c8a26594 |
Provenance
File details
Details for the file roms_tools-1.3.0-py3-none-any.whl.
File metadata
- Download URL: roms_tools-1.3.0-py3-none-any.whl
- Upload date:
- Size: 604.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 400f9ac040aa176bfed1dc7d80bf284389f0c8cb3bedeefde8c0d9729f687bd6 |
|
| MD5 | 5133b0d87c1678310d0b36dd673947a9 |
|
| BLAKE2b-256 | 6b62191b648e516f38ca3ba60df81f6d2b2fab29c6645cc08e9018f1cfb85b5b |
