README.md

E3SM Diagnostics Package

Table of Contents

1. Documentation
2. Overview
3. Current State

Documentation

• Documentation Website
• Sample Output, Model vs Observations
• Quick Start Guides:
  • Quick Start Guide for NERSC Cori
  • Quick Start Guide for COMPY
  • Quick Start Guide for LCRC-Anvil
  • Quick Start Guide for LCRC-Chrysalis
• Example run scripts:
  • Model Climo vs Observation Climo Comparison
  • Model Climo vs Model Climo Comparison
  • Model Time-series vs Model Time-series
  • Model Time-series vs Model Time-series with CMIP data
  • Model Time-series vs Observation Time-series with CMIP data
  • Observation vs Observation Comparison

Overview

This diagnostics package is constructed for supporting the diagnostics task of DOE's Energy Exascale Earth System Model (E3SM) project. The goal of this work is to develop a comprehensive diagnostics package that:

• fully integrates the functionality of NCAR's AMWG diagnostics package.
• utilizes most updated observational datasets, including remote sensing, reanalysis and in-situ datasets.
• interfaces with diagnostics developed from different E3SM science groups
• is flexible for user specified diagnostics and being configured for use by other climate models (i.e. in CMIP format).

Current State

Algorithm and visualization codes for lat-lon contour plots (Figure 1), polar contour plots (Figure 2), zonal mean 2d plots (Figure 3), zonal mean line plots (Figure 4), 2d joint histogram for COSP cloud simulator output (Figure 5), tables (Figure 6) and Taylor Diagrams (Figure 7) summarizing metrics, for climatology seasonal means, are implemented as core sets of this diagnostics package. More diagnostics harvested from E3SM v1 and v2 development are also supported. Example of a complete set of diagnostics can be found here

The package features built-in user diagnostics, by specifying user desired diagnostics regions and pressure levels for variables with the vertical dimension.

In addition to default model versus observation comparison, the package also provide support for model versus model and obs versus obs comparisons.

Figure 1: An example of the lat-lon contour plots for air temperature at 850 mb with tropical ocean region considered

Figure 2: An example of the polar contour plots for precipitation rate

Figure 3: An example of the pressure-lat contour plots for air temperature

Figure 4: An example of the zonal mean surface air temperature line plot

Figure 5: An example of 2d joint histogram plot using COSP simulator output

Figure 6: An example of table summarizing metrics calculated based on lat-lon contour plots diagnostics

Figure 7: An example of Taylor diagram summarizing metrics calculated based on lat-lon contour plots diagnostics of several key variables

Reference

Zhang, Chengzhu, Jean-Christophe Golaz, Ryan Forsyth, Tom Vo, Shaocheng Xie, Zeshawn Shaheen, Gerald L. Potter et al. "The E3SM Diagnostics Package (E3SM Diags v2): A Python-based Diagnostics Package for Earth System Models Evaluation." Geoscientific Model Development Discussions (2022): 1-35.

Acknowledgement

The work is performed for the E3SM project, which is sponsored by Earth System Model Development (ESMD) program. ESMD is a program area for the Earth and Environmental Systems Sciences Division (EESSD) in the Office of Biological and Environmental Research (BER) within the Department of Energy's Office of Science.

License

Copyright (c) 2018-2021, Energy Exascale Earth System Model Project All rights reserved

SPDX-License-Identifier: (BSD-3-Clause)

See LICENSE for details

Unlimited Open Source - BSD 3-clause Distribution LLNL-CODE-819717