Skip to content

NCAR/CTSM-Tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jupyter Build

GitHub license Made withJupyter Commits Contributors

Numerous versions of this tutorial can be found in this repository's branches.

The materials and notebooks in this tutorial is published as a Jupyter book here.

This repository includes materials for tutorials such as the Community Terrestrial Systems Model (CTSM) 2022 mini-tutorial (link to agenda and resources).

These tutorials are designed as an introduction to running the Community Terrestrial Systems Model (CTSM). We will go through three configurations that include running a:

  1. Supported NEON tower site,
  2. Global FATES-SP simulation, and
  3. Generic single point simulation.

We'll also learn how to:

  • Visualize results,
  • Analyze model output, and
  • Make simple code modifications.

This video will walk you through the initial steps of the tutorial, but the steps for quick start are also summarized below.

Watch the video

The full set of lectures from the tutorial can be found here, and will be posted after the tutorial.

Quick Start

Step 1: Open up CESM-Lab

  • In your web browser go to the provided cloud link for the particular tutorial which you are attending.

    It will automatically open up a portal to connect to the cloud:

    Screen Shot 2022-05-17 at 1 58 17 AM

  • Enter your username and password provided with your tutorial registration

  • This should launch a JupyterLab window in your browser.

Step 2: Clone CTSM Tutorial Repository

  • Click on the Terminal icon to open a terminal window.

Screen Shot 2022-05-17 at 2 05 32 AM

  • Run the following command to clone this repository. (Just copy and paste the text below into the terminal window that opens in JupyterLab). You can also specify a particular branch which you'd like to clone, if you are interested in a particular tutorial.
git clone https://github.com/NCAR/CTSM-Tutorial

This gives you a local copy of the material you'll need for the tutorial

Can you see a new directory on your navigation sidebar called CTSM-Tutorial? (See the left sidebar of your JupyterLab window) Screen Shot 2022-05-17 at 4 46 13 PM

Step 3: Navigate to notebooks directory

  • Click on the CTSM-Tutorial directory
  • Click on the notebooks directory
  • Click on the Day0a_GitStarted.ipynb notebook in the sidebar of your JupyterLab window.

Notebook Table of Contents (Note: see individual section README.md files for more details on each section)

  • Global: These tutorials focus on cases that are run globally.
  • SinglePoint: These tutorials focus on cases that are run at a single point.
    • GettingStarted: These notebooks are the building blocks for all additional notebooks.
    • BuildingBlocks: These notebooks are intended as tools that you can add to your toolbox to better understand details from ProjectExamples.
    • ProjectExamples: These notebooks are project-specific and build upon the GettingStarted notebooks
    • ContributedNotebooks: These notebooks are contributed by workshop participants who dove further into a particular project.

📚 Resources

CTSM Repository which includes the CTSM Wiki page that has lots of resources, including much of the following:

CLM5 Overview Paper Lawrence et al. 2019 JAMES

CLM5 Diagnostic plots, from the overview paper.

CLM5 ILAMB page, also from the overview paper.

❓ Questions

For questions about running simulations, please use DiscussCESM Forums:

Containers & Cloud Platforms Forum

CTSM Forum

👍 Acknowledgements

A number of people have been critical to this effort, including:

  • Adrianna Foster, Negin Sobhani, Danica Lombardozzi, Will Wieder, Teagan King, and Gordon Bonan who put together tutorial materials.
  • Brian Dobbins, who put together the AWS configuration of CESM-Lab;
  • Jackie Shuman, Polly Buotte, Keith Oleson, Linnia Hawkins, and Katya Jay who tested tutorial materials;
  • Erik Kluzek & Bill Sacks, who made CTSM tags needed for running simulations.
  • Elizabeth Faircloth and Ryan Johnson who helped with tutorial registration, logistics and webpages; and finally the rest of the
  • TSS staff who provided lecture materials and helped answer questions during the tutorial.

This material is based upon work supported by the National Center for Atmospheric Research (NCAR), which is a major facility sponsored by the National Science Foundation (NSF) under Cooperative Agreement No. 1852977. Staff time on this project was also supported by NSF award numbers 2039932, 2031238, 1926413, and 2120804.