Lab-0016

Introduction to CSDMS Tools: Python Modeling Toolkit (pymt)

Model
CEM

Duration
2.0 hrs

Updated
2020/08/26

Download
download

Run online using:

1. Jupyter

     

Contributor(s)

    Eric Hutton at INSTAAR - University of Colorado Boulder.

    Mark Piper at INSTAAR - University of Colorado Boulder.

    Greg Tucker at Geological Sciences - University of Colorado Boulder.

    Irina Overeem at INSTAAR - University of Colorado Boulder.

Introduction

pymt provides tools for coupling models with disparate time and space scales that expose the Basic Model Interface (BMI). It includes a collection of Earth-surface models and is an extensible plug-in framework for adding new models. Detailed information on pymt can be accessed at https://pymt.readthedocs.io.

Classroom organization
In this lab, we will explore a series of Jupyter Notebooks that show how to use pymt to run and couple models. This lab will first introduce pymt and demonstrate how to setup, initialize, run and finalize a model. Then, it will show how to use pymt to run a standalone model (Hydrotrend) and couple two models (CEM + Waves). The lab also includes additional Jupyter Notebooks for other model components in pymt (e.g., Frost Number Model, Kudryavtsev Model).

Learning objectives
Skills

• Learn how to run a standalone model in pymt
• Learn how to couple two models using pymt

Key concepts

• Why use pymt
• pymt library of models
• How to set up, initialize, run, and finalize a model in pymt

Lab notes

This lab can be run on the CSDMS JupyterHub. (If you don't already have an account, follow the instructions to sign up at: https://csdms.colorado.edu/wiki/JupyterHub.) Run the lab Notebook by clicking the "start" link under the Run online heading at the top of this page. If you're an educator using this lab in a class, you can get CSDMS JupyterHub accounts for students. For more information, please contact us through the CSDMS Help Desk: https://github.com/csdms/help-desk.

Requirements
If run locally, this lab requires the installtion of pymt; see https://pymt.readthedocs.io/en/latest/quickstart.html for instructions. This lab runs on Linux and macOS.

Acknowledgements
This material is based upon work supported by the National Science Foundation under Grant No. 1831623, Community Facility Support: The Community Surface Dynamics Modeling System (CSDMS).

References

• Eric Hutton, & Mark Piper. (2020, February 5). csdms/pymt: The Python Modeling Toolkit (Version v1.0.0). Zenodo. http://doi.org/10.5281/zenodo.3644240