Skip to content

gantian127/pymt_era5

Repository files navigation

pymt_era5

Basic Model Interface Documentation Status

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

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 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

Installing pymt_era5

To install pymt_era5, use pip

pip install pymt_era5

or conda

conda install -c conda-forge pymt_era5

Citation

Please include the following references when citing this software package:

Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J., Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024: CSDMS Data Components: data–model integration tools for Earth surface processes modeling. Geosci. Model Dev., 17, 2165–2185. https://doi.org/10.5194/gmd-17-2165-2024

Gan, T. (2025). PyMT plugin for CSDMS ERA5 Data Component. Zenodo. https://zenodo.org/doi/10.5281/zenodo.10368880

Coding Example

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