Skip to content

pymt-lab/pymt_dbseabed

 
 

Repository files navigation

pymt_dbseabed

Basic Model Interface Documentation Status

pymt_dbseabed is a package that uses the bmi_dbseabed pacakge to convert dbSEABED datasets into a reusable, plug-and-play data component for PyMT modeling framework developed by Community Surface Dynamics Modeling System (CSDMS). This allows dbSEABED datasets 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

** Please make sure to install python=3.11, model_metadata=v0.7, gimli=v0.2.4, gimli.units=0.3.0. Otherwise, you may encounter import error for pymt_dbseabed.

Installing pymt_dbseabed

To install pymt_dbseabed, use pip

pip install pymt_dbseabed

or conda

conda install -c conda-forge pymt_dbseabed

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 dbSEABED Data Component. Zenodo. https://doi.org/10.5281/zenodo.15022017

Coding Example

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

About

PyMT plugin for dbSEABED dataset.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 62.0%
  • Makefile 21.6%
  • Python 16.4%