Skip to content

PCMDI/pcmdi_metrics

Repository files navigation





PCMDI Metrics Package (PMP)

latest version Last updated platforms DOI License Formatted with black All Contributors

Conda-forge (NEW, recommended): Download

PCMDI Conda Channel (halted): Download

The PCMDI Metrics Package (PMP) is used to provide "quick-look" objective comparisons of Earth System Models (ESMs) with one another and available observations. Results are produced in the context of all model simulations contributed to CMIP6 and earlier CMIP phases. Among other purposes, this enables modeling groups to evaluate changes during the development cycle in the context of the structural error distribution of the multi-model ensemble. Currently, the comparisons emphasize metrics of large- to global-scale annual cycle, tropical and extra-tropical modes of variability, ENSO, MJO, regional monsoons, high frequency characteristics of simulated precipitation, and cloud feedback.

PCMDI uses the PMP to produce quick-look simulation summaries across generations of CMIP.

The metrics package consists of the following parts:

The package expects model data to be CF-compliant. To successfully use the package some input data "conditioning" may be required. We provide several demo scripts within the package.

Documentation

Getting Started

  • Installation requirements and instructions are available on the Install page

  • Users will need to contact the PMP developers ([email protected]) to obtain supporting datasets and get started using the package.

  • An overview for using the package and template scripts are detailed on the Using-the-package page

  • View Demo

Reference

Lee, J., P. J. Gleckler, M.-S. Ahn, A. Ordonez, P. Ullrich, K. R. Sperber, K. E. Taylor, Y. Y. Planton, E. Guilyardi, P. Durack, C. Bonfils, M. D. Zelinka, L.-W. Chao, B. Dong, C. Doutriaux, C. Zhang, T. Vo, J. Boutte, M. F. Wehner, A. G. Pendergrass, D. Kim, Z. Xue, A. T. Wittenberg, and J. Krasting, 2024: Systematic and Objective Evaluation of Earth System Models: PCMDI Metrics Package (PMP) version 3. Geoscientific Model Development (accepted, publication in progress) [preprint]

Contact

Report Bug

Request Feature

Some installation support for CMIP participating modeling groups is available: [email protected]

Acknowledgement

Content in this repository is developed by climate and computer scientists from the Program for Climate Model Diagnosis and Intercomparison (PCMDI) at Lawrence Livermore National Laboratory (LLNL). This work is sponsored by the Regional and Global Model Analysis (RGMA) program, of 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. The work is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.

Program for Climate Model Diagnosis and IntercomparisonΒ  United States Department of EnergyΒ  Lawrence Livermore National Laboratory

License

Distributed under the BSD 3-Clause License. See LICENSE for more information.

Release Notes and History

Update summary
v3.4 Technical update: Modes of variability xCDAT conversion
v3.3.4 Technical update
v3.3.3 Technical update
v3.3.2 Technical update
v3.3.1 Technical update
v3.3 New metric added: Sea-Ice
v3.2 New metric added: Extremes
v3.1.2 Technical update
v3.1.1 Technical and documentation update
v3.1 New metric added: Precipitation Benchmarking -- distribution bimodality
v3.0.2 Minor patch and more documentation added
v3.0.1 Minor technical patch
v3.0.0 New metric added: Cloud feedback metric by @mzelinka. xCDAT implemented for mean climate metrics
v2.5.1 Technical update
v2.5.0 New metric added: Precipitation Benchmarking -- distribution. Graphics updated
v2.4.0 New metric added: AMO in variability modes
v2.3.2 CMEC interface updates
v2.3.1 Technical update
v2.3 New graphics using archived PMP results
v2.2.2 Technical update
v2.2.1 Minor update
v2.2 New metric implemented: precipitation variability across time scale
v2.1.2 Minor update
v2.1.1 Simplified dependent libraries and CI process
v2.1.0 CMEC driver interfaced added.
v2.0 New capabilities: ENSO metrics, demos, and documentations.
v1.2 Tied to CDAT 8.0. Extensive regression testing added. New metrics: Diurnal cycle and intermittency of precipitation, sample monsoon metrics.
v1.1.2 Now managed through Anaconda, and tied to UV-CDAT 2.10. Weights on bias statistic added. Extensive provenance information incorporated into json files.
v1.1 First public release, emphasizing climatological statistics, with development branches for ENSO and regional monsoon precipitation indices
v1.0 Prototype version of the PMP

Contributors

Thanks goes to these wonderful people (emoji key):

Jiwoo Lee
Jiwoo Lee

πŸ’» πŸ“– πŸ‘€ ⚠️ βœ… πŸ”¬ πŸ€” πŸš‡
Peter Gleckler
Peter Gleckler

πŸ’» πŸ“– πŸ”¬ πŸ‘€ ⚠️ πŸ”£ πŸ€”
Ana Ordonez
Ana Ordonez

πŸ’» πŸ“– πŸ‘€ ⚠️ βœ… πŸš‡
Min-Seop Ahn
Min-Seop Ahn

πŸ’» πŸ“– πŸ‘€ ⚠️ βœ… πŸ”¬
Paul Ullrich
Paul Ullrich

πŸ€” πŸ”¬
Charles Doutriaux
Charles Doutriaux

πŸ’»
Karl Taylor
Karl Taylor

πŸ”¬ πŸ€”
Paul J. Durack
Paul J. Durack

πŸ’»
Mark Zelinka
Mark Zelinka

πŸ’»
Celine Bonfils
Celine Bonfils

πŸ”¬
Curtis C. Covey
Curtis C. Covey

πŸ’» πŸ”¬
Zeshawn Shaheen
Zeshawn Shaheen

πŸ’»
Lina Muryanto
Lina Muryanto

πŸš‡
Tom Vo
Tom Vo

πŸš‡
Jason Boutte
Jason Boutte

πŸš‡
Jeffrey Painter
Jeffrey Painter

πŸ”£ πŸš‡ πŸ’»
Stephen Po-Chedley
Stephen Po-Chedley

πŸ”£ πŸš‡
Xylar Asay-Davis
Xylar Asay-Davis

πŸš‡
John Krasting
John Krasting

πŸ’» ⚠️
Angeline G Pendergrass
Angeline G Pendergrass

πŸ’» πŸ”¬ πŸ€”
Michael Wehner
Michael Wehner

πŸ’» πŸ”¬
Daehyun Kim
Daehyun Kim

πŸ’» πŸ”¬

This project follows the all-contributors specification.