Lab-0016: Difference between revisions

From CSDMS
No edit summary
No edit summary
Line 1: Line 1:
{{Labbasics
{{Labbasics
|Labtitle=Introduction to CSDMS Tools - Python Modeling Toolkit (pymt)
|Labtitle=Introduction to CSDMS Tools: Python Modeling Toolkit (pymt)
|LabCOModule=1 of 1
|LabCOModule=1 of 1
|LabDateContributedOrUpdated=2020/06/04
|LabDateContributedOrUpdated=2020/08/26
|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=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.
|LabCODuration=2.0 hrs
|LabCODuration=2.0 hrs
|LabModelDocumentation=None
|LabModelDocumentation=None
|LabAssociatedLesson=Jupyter Notebook
|LabAssociatedLesson=Jupyter Notebook
|LabURLDownloadNotebook=https://github.com/csdms/csdms-2020/archive/v1.0.zip
|LabURLStartNotebook=https://csdms.rc.colorado.edu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fcsdms-2020&urlpath=tree%2Fcsdms-2020%2Fnotebooks%2Fpymt%2Findex.ipynb&branch=master
|LabURLStartNotebook=https://csdms.rc.colorado.edu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fcsdms-2020&urlpath=tree%2Fcsdms-2020%2Fnotebooks%2Fpymt%2Findex.ipynb&branch=master
}}
}}
Line 26: Line 27:
}}
}}
{{LabIntro
{{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 for ''pymt'' can be accessed at https://pymt.readthedocs.io.
|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.
|LabPicture=PyMT-logo-below-lowercase.png
|LabPicture=PyMT-logo-below-lowercase.png
}}
}}
{{LabClassroomOrganization
{{LabClassroomOrganization
|LabCOIntro=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).
|LabCOIntro=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).
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.
}}
}}
{{LabLearningObjectivesSkills
{{LabLearningObjectivesSkills
Line 52: Line 50:
}}
}}
{{LabNotes
{{LabNotes
|LabNotesInstructions=Instead of running lab Notebooks through the CSDMS JupyterHub, you can also run them on Binder. Follow these steps:
|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://github.com/csdms/help-desk.
 
|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.
 
>> Open a new browser window and go to: https://pymt.readthedocs.io/en/latest/examples.html
 
>> You will see that there are several examples.
 
>> Click on the "Launch Binder" button to run one of the Notebooks.
 
Note that Binder is a free and popular service for running Jupyter Notebooks, so it can be slow to load at times.
|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)''.
|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)''.
}}
}}

Revision as of 15:56, 26 August 2020

Introduction to CSDMS Tools: Python Modeling Toolkit (pymt)

Model
None
Duration
2.0 hrs
Updated
2020/08/26
Download
download
Run online using:
  1. Jupyter
     Jupyter logo.png

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-logo-below-lowercase.png
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
Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Lab-0016&oldid=297262"