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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for roms_tools-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a1306f6e4b0c317515431ab99ff10954891a4f9da142d1984bcf5164ff036db6
MD5 f100167be5ab5a5c354ed01029efd2de
BLAKE2b-256 a287fa161d2945f869fab14acf2333d256f238f56b4b1a04a236996dcda74ef9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for roms_tools-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f516018c9c0144decc172e87517ed114621a4ed85feefda43e912d641f58a64c
MD5 e29d001c60df2f4d74085e687e49ca38
BLAKE2b-256 ec998632e5fefb822509493b1fb52c606e5b332366f1621b45382bfa5744c649

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