LMWG Winter Meeting 2026: CTSM‐CUPID Tutorial - ESCOMP/CTSM GitHub Wiki

Welcome to the CTSM-CUPiD Tutorial!

Introduction:

Thanks for joining us today! We are glad you are here and excited to talk to you about CTSM and CUPiD and how to use them for your scientific analysis.

ctsm6.0 will include the CESM Unified Postprocessing and Diagnostics (CUPiD) python framework. For this tutorial we will be using a preliminary version of CTSM with CUPiD enabled

Development of CUPiD is guided by its vision statement:

CUPiD is a “one stop shop” that enables and integrates timeseries file generation, data standardization, diagnostics, and metrics from all CESM components.

This collaborative effort aims to simplify the user experience of running diagnostics by calling post-processing tools directly from CUPiD, running all component diagnostics from the same tool as either part of the CIME workflow or independently, and sharing python code and a standard conda environment across components.

This collaborative effort aims to simplify the user experience of running diagnostics by calling post-processing tools directly from CUPiD, running all component diagnostics from the same tool as either part of the CIME workflow or independently, and sharing python code and a standard conda environment across components.

Learning objectives:

  • Learn how to checkout CTSM and CUPiD
  • Learn how to setup CTSM and CUPiD to run diagnostics
  • Learn how to use to use CUPiD to run both the LDF and ILAMB diagnostics
  • Learn how to run CUPiD from a CTSM case

Technical skills that are needed:

  • Able to use Linux OS for command line operation (using bash)
  • Some familiarity with running Python scripts
  • Familiarity with using conda environments for Python scripts

Technical skills that will help, but you will learn something about:

  • Familiarity with creating/building/running CTSM I compset cases
  • Familiarity with NSF-NCAR machine Derecho and Casper as well as JupyterHub
  • Familiarity with git commands
  • Running/modifying Jupyter notebooks will be an optional thing you can do on your own

The outline of what we will go through is:

  1. Specific Setup to NSF-NCAR Machines
  2. Installing CUPiD
  3. CUPiD Overview
  4. Running CUPiD/LDF/ILAMB for existing case
  5. Examine the CUPiD Config file (config.yml)
  6. Running a CTSM case with CUPiD post processing turned on
  7. Conclusion and next steps