pymt-roms 0.1.1

PyMT plugin for pymt_roms

pymt_roms is a package that converts bmi_roms package into a reusable, plug-and-play data component for PyMT modeling framework developed by Community Surface Dynamics Modeling System (CSDMS). This allows ROMS model datasets to be easily coupled with other datasets or models that expose a Basic Model Interface.

The current implementation supports 2D, 3D and 4D ROMS output datasets defined with geospatial and/or time dimensions (e.g., dataset defined with dimensions as [time, s_rho, eta_rho, xi_rho])

Component	PyMT
Roms	from pymt.models import Roms

Installing pymt

Installing pymt from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Note: Before installing pymt, you may want to create a separate environment into which to install it. This can be done with,

conda create -n pymt python=3
conda activate pymt

Once the environment is activated, pymt can be installed with the following command. Please note that pymt_roms requires pymt version 1.3.2 or higher.

# install pymt stable release and dependency packages
$ conda install pymt

# update to pymt dev version
$ pip install git+http://github.com/csdms/pymt

Installing pymt_roms

To install pymt_roms, use pip

pip install pymt_roms

or conda

conda install -c conda-forge pymt_roms

Coding Example

You can learn more details about the coding example from the tutorial notebook.

Credits

• Tian Gan <[e-mail]>

Changelog for pymt_roms

0.1.1 (2024-10-31)

• Update for pymt 1.3.2

0.1.0 (2023-04-04)

• Initial release