Skip to main content

Tools for running and analysing UCLA-ROMS simulations

Project description

ROMS-Tools

PyPI version codecov Documentation Status Run Tests Supported Python Versions

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-1.0.1.tar.gz (9.8 MB view details)

Uploaded Source

Built Distribution

roms_tools-1.0.1-py3-none-any.whl (109.6 kB view details)

Uploaded Python 3

File details

Details for the file roms_tools-1.0.1.tar.gz.

File metadata

  • Download URL: roms_tools-1.0.1.tar.gz
  • Upload date:
  • Size: 9.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for roms_tools-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b8d245eb3018c030b35b7625ec3a06c76070009f1eb6236651a09809a91b4101
MD5 38157ebc643096ba94b126d262a2f54b
BLAKE2b-256 bd3fc9e8edda50fe667725b6d56d513e6b630750008565d7cfd45ad63b70e3d3

See more details on using hashes here.

File details

Details for the file roms_tools-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: roms_tools-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 109.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for roms_tools-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cbad63b9161b1342cdc0bd377a5a9e3e5b4c7bf1b75eed345fdf4ebf4e27972
MD5 6bc0b2f99351e8d654e4c05060bb2aef
BLAKE2b-256 72c001525ac6133d6c819103439d8b039378571d7cce6353bcf568eadae6ba97

See more details on using hashes here.

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