Skip to main content

Tools for running and analysing UCLA-ROMS simulations

Project description

ROMS-Tools

codecov Documentation Status PyPI version

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, clone the source repository and install it:

git clone https://github.com/CWorthy-ocean/roms-tools.git
cd roms-tools
pip install -e .

Run the tests

Before running the tests, you can install and activate the following conda environment:

cd roms-tools
conda env create -f ci/environment.yml
conda activate romstools

Check the installation of ROMS-Tools has worked by running the test suite

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roms_tools-0.20.tar.gz (10.5 MB view hashes)

Uploaded Source

Built Distribution

roms_tools-0.20-py3-none-any.whl (92.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page