Lab-0016: Difference between revisions

Revision as of 13:52, 19 April 2022

CSDMS Workbench: Python Modeling Toolkit (pymt)

Model
CEM

Duration
2.0 hrs

Updated
2022-04-19

Download
download

Run online using:

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 a 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 found at https://pymt.readthedocs.io.

pymt is an element of the CSDMS Workbench, an integrated system of software tools, technologies, and standards for building and coupling models.

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 lab (for educators) and jupyter (for general use) instances of the OpenEarthscape JupyterHub: just click one of the links under the Run online using heading at the top of this page, then run the notebook in the "CSDMS" kernel.

If you don't already have a JupyterHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk: https://csdms.github.io/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

@@ Line 1: / Line 1: @@
 {{Labbasics
-|Labtitle=Introduction to CSDMS Tools: Python Modeling Toolkit (pymt)
+|Labtitle=CSDMS Workbench: Python Modeling Toolkit (pymt)
 |LabCOModule=1 of 1
-|LabDateContributedOrUpdated=2020-08-26
+|LabDateContributedOrUpdated=2022-04-19
-|LabDescriptionShort=pymt is the Python Modeling Toolkit that provides the tools needed for coupling models that expose the Basic Model Interface (BMI). This lab illustrates how to use pymt to run and couple models.
+|LabDescriptionShort=The Python Modeling Toolkit (pymt) provides the tools needed for coupling models that expose a Basic Model Interface (BMI). This lab illustrates how to use pymt to run and couple models.
 |LabCODuration=2.0 hrs
 |LabModelDocumentation=CEM
@@ Line 27: / Line 27: @@
 }}
 {{LabIntro
-|LabDescription=''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.
+|LabDescription=<p>''pymt'' provides tools for coupling models with disparate time and space scales that expose a 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 found at https://pymt.readthedocs.io.<p>
+<p>''pymt'' is an element of the CSDMS Workbench, an integrated system of software tools, technologies, and standards for building and coupling models.</p>
 |LabPicture=PyMT-logo-below-lowercase.png
 }}
@@ Line 50: / Line 52: @@
 }}
 {{LabNotes
-|LabNotesInstructions=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://csdms.github.io/help-desk.
+|LabNotesInstructions=<p>This lab can be run on the <em>lab</em> (for educators) and <em>jupyter</em> (for general use) instances of the OpenEarthscape JupyterHub: just click one of the links under the <strong>Run online using</strong> heading at the top of this page, then run the notebook in  the "CSDMS" kernel.</p>
+<p>If you don't already have a JupyterHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk: https://csdms.github.io/help-desk.</p>
 |LabNotesRequirements=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.
 |LabAcknowledgements=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)''.