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 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 conda-forge channel has been enabled, pymt can be installed with:
conda install pymt
It is possible to list all of the versions of pymt available on your platform with:
conda search pymt --channel conda-forge
Please note that pymt_roms requires pymt version 1.3.2 or higher
To install pymt_roms, use pip
pip install pymt_roms
or conda
conda install -c conda-forge pymt_roms
You can learn more details about the coding example from the tutorial notebook.