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

Uploaded Source

Built Distribution

roms_tools-1.2.0-py3-none-any.whl (109.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: roms_tools-1.2.0.tar.gz
  • Upload date:
  • Size: 8.7 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.2.0.tar.gz
Algorithm Hash digest
SHA256 03f34e250ee78a0b8c3e0e3669c7daf40b2e705e8b15088caa717866cf702e2b
MD5 2cd6d71ab374c91d63dc6b300e1d1683
BLAKE2b-256 7f263fe1d3e743743b67d8e792c060a81cb7bc395c5b098298df8c8b157a5747

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roms_tools-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 109.4 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6dcf43138ebbab0ad26ed718700703dd0f2c4831a12faaaac3595a63769d4ab
MD5 245a4505a1317362a262b8afb4111960
BLAKE2b-256 65629639f3ae48fd20a35650d8a6c20ffb58b4b1f14690bfdc7a542a9199bb34

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