Home

Awesome

<div> <img src="share/pcmdi/PMPLogo_1359x1146px_300dpi.png" height="90" align="right" /> <img src="share/pcmdi/PCMDILogo_400x131px_72dpi.png" height="60" align="right" /> </div>

<br><br><br><br>

PCMDI Metrics Package (PMP)

<!-- badges: start -->

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

Conda-forge (CURRENT, recommended): Download

PCMDI Conda Channel (old, deprecated): Download

<!-- badges: end -->

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

References

Latest:

Earlier versions:

Contact

Report Bug

Request Feature

Some installation support for CMIP participating modeling groups is available: pcmdi-metrics@llnl.gov

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.

<p> <img src="https://pcmdi.github.io/assets/PCMDI/100px-PCMDI-Logo-NoText-square-png8.png" width="65" style="margin-right: 30px" title="Program for Climate Model Diagnosis and Intercomparison" alt="Program for Climate Model Diagnosis and Intercomparison" >&nbsp; <img src="https://github.com/PCMDI/assets/blob/main/DOE/480px-DOE_Seal_Color.png?raw=true" width="65" style="margin-right: 30px" title="United States Department of Energy" alt="United States Department of Energy" >&nbsp; <img src="https://github.com/PCMDI/assets/blob/main/LLNL/212px-LLNLiconPMS286-WHITEBACKGROUND.png?raw=true" width="65" title="Lawrence Livermore National Laboratory" alt="Lawrence Livermore National Laboratory" > </p>

License

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

Release Notes and History

<div style="width:300%">Versions</div>Update summary
v3.7.2Technical update
v3.7.1Technical update with documentation improvements
v3.7New capability (figure generation for mean climate) and technical update
v3.6.1Technical update, additional QC repair functions
v3.6New capability (regional application of precip variability) and technical update
v3.5.2New capability (QC, new modes for modes of variability metrics: PSA1, PSA2) and technical update
v3.5.1Technical update
v3.5Technical update: MJO and Monsoon Sperber xCDAT conversion
v3.4.1Technical update
v3.4Technical update: Modes of variability xCDAT conversion
v3.3.4Technical update
v3.3.3Technical update
v3.3.2Technical update
v3.3.1Technical update
v3.3New metric added: Sea-Ice
v3.2New metric added: Extremes
v3.1.2Technical update
v3.1.1Technical and documentation update
v3.1New metric added: Precipitation Benchmarking -- distribution bimodality
v3.0.2Minor patch and more documentation added
v3.0.1Minor technical patch
v3.0.0New metric added: Cloud feedback metric by @mzelinka. xCDAT implemented for mean climate metrics
<details> <summary>Click here for older versions</summary>
<div style="width:300%">Versions</div>Update summary
v2.5.1Technical update
v2.5.0New metric added: Precipitation Benchmarking -- distribution. Graphics updated
v2.4.0New metric added: AMO in variability modes
v2.3.2CMEC interface updates
v2.3.1Technical update
v2.3New graphics using archived PMP results
v2.2.2Technical update
v2.2.1Minor update
v2.2New metric implemented: precipitation variability across time scale
v2.1.2Minor update
v2.1.1Simplified dependent libraries and CI process
v2.1.0CMEC driver interfaced added.
v2.0New capabilities: ENSO metrics, demos, and documentations.
v1.2Tied to CDAT 8.0. Extensive regression testing added. New metrics: Diurnal cycle and intermittency of precipitation, sample monsoon metrics.
v1.1.2Now managed through Anaconda, and tied to UV-CDAT 2.10. Weights on bias statistic added. Extensive provenance information incorporated into json files.
v1.1First public release, emphasizing climatological statistics, with development branches for ENSO and regional monsoon precipitation indices
v1.0Prototype version of the PMP
</details>

Current Core Team Members at PCMDI/LLNL

All Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://sites.google.com/view/jiwoolee"><img src="https://avatars.githubusercontent.com/u/17091564?v=4?s=100" width="100px;" alt="Jiwoo Lee"/><br /><sub><b>Jiwoo Lee</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=lee1043" title="Code">💻</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=lee1043" title="Documentation">📖</a> <a href="https://github.com/PCMDI/pcmdi_metrics/pulls?q=is%3Apr+reviewed-by%3Alee1043" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=lee1043" title="Tests">⚠️</a> <a href="#tutorial-lee1043" title="Tutorials">✅</a> <a href="#research-lee1043" title="Research">🔬</a> <a href="#ideas-lee1043" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-lee1043" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/gleckler1"><img src="https://avatars.githubusercontent.com/u/4553389?v=4?s=100" width="100px;" alt="Peter Gleckler"/><br /><sub><b>Peter Gleckler</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=gleckler1" title="Code">💻</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=gleckler1" title="Documentation">📖</a> <a href="#research-gleckler1" title="Research">🔬</a> <a href="https://github.com/PCMDI/pcmdi_metrics/pulls?q=is%3Apr+reviewed-by%3Agleckler1" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=gleckler1" title="Tests">⚠️</a> <a href="#data-gleckler1" title="Data">🔣</a> <a href="#ideas-gleckler1" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/acordonez"><img src="https://avatars.githubusercontent.com/u/18147700?v=4?s=100" width="100px;" alt="Ana Ordonez"/><br /><sub><b>Ana Ordonez</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=acordonez" title="Code">💻</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=acordonez" title="Documentation">📖</a> <a href="https://github.com/PCMDI/pcmdi_metrics/pulls?q=is%3Apr+reviewed-by%3Aacordonez" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=acordonez" title="Tests">⚠️</a> <a href="#tutorial-acordonez" title="Tutorials">✅</a> <a href="#infra-acordonez" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/msahn"><img src="https://avatars.githubusercontent.com/u/46369397?v=4?s=100" width="100px;" alt="Min-Seop Ahn"/><br /><sub><b>Min-Seop Ahn</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=msahn" title="Code">💻</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=msahn" title="Documentation">📖</a> <a href="https://github.com/PCMDI/pcmdi_metrics/pulls?q=is%3Apr+reviewed-by%3Amsahn" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=msahn" title="Tests">⚠️</a> <a href="#tutorial-msahn" title="Tutorials">✅</a> <a href="#research-msahn" title="Research">🔬</a></td> <td align="center" valign="top" width="14.28%"><a href="http://climate.ucdavis.edu/"><img src="https://avatars.githubusercontent.com/u/5330916?v=4?s=100" width="100px;" alt="Paul Ullrich"/><br /><sub><b>Paul Ullrich</b></sub></a><br /><a href="#ideas-paullric" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-paullric" title="Research">🔬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/doutriaux1"><img src="https://avatars.githubusercontent.com/u/2781425?v=4?s=100" width="100px;" alt="Charles Doutriaux"/><br /><sub><b>Charles Doutriaux</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=doutriaux1" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/taylor13"><img src="https://avatars.githubusercontent.com/u/4993439?v=4?s=100" width="100px;" alt="Karl Taylor"/><br /><sub><b>Karl Taylor</b></sub></a><br /><a href="#research-taylor13" title="Research">🔬</a> <a href="#ideas-taylor13" title="Ideas, Planning, & Feedback">🤔</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/durack1"><img src="https://avatars.githubusercontent.com/u/3229632?v=4?s=100" width="100px;" alt="Paul J. Durack"/><br /><sub><b>Paul J. Durack</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=durack1" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://mzelinka.github.io/"><img src="https://avatars.githubusercontent.com/u/11380489?v=4?s=100" width="100px;" alt="Mark Zelinka"/><br /><sub><b>Mark Zelinka</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=mzelinka" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/bonfils2"><img src="https://avatars.githubusercontent.com/u/3536584?v=4?s=100" width="100px;" alt="Celine Bonfils"/><br /><sub><b>Celine Bonfils</b></sub></a><br /><a href="#research-bonfils2" title="Research">🔬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://pcmdi.llnl.gov/staff/covey/"><img src="https://pcmdi.llnl.gov/staff/covey/curt.jpg?s=100" width="100px;" alt="Curtis C. Covey"/><br /><sub><b>Curtis C. Covey</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=" title="Code">💻</a> <a href="#research" title="Research">🔬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/zshaheen"><img src="https://avatars.githubusercontent.com/u/4239938?v=4?s=100" width="100px;" alt="Zeshawn Shaheen"/><br /><sub><b>Zeshawn Shaheen</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=zshaheen" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/muryanto1"><img src="https://avatars.githubusercontent.com/u/35277663?v=4?s=100" width="100px;" alt="Lina Muryanto"/><br /><sub><b>Lina Muryanto</b></sub></a><br /><a href="#infra-muryanto1" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/tomvothecoder"><img src="https://avatars.githubusercontent.com/u/25624127?v=4?s=100" width="100px;" alt="Tom Vo"/><br /><sub><b>Tom Vo</b></sub></a><br /><a href="#infra-tomvothecoder" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jasonb5"><img src="https://avatars.githubusercontent.com/u/2191036?v=4?s=100" width="100px;" alt="Jason Boutte"/><br /><sub><b>Jason Boutte</b></sub></a><br /><a href="#infra-jasonb5" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/painter1"><img src="https://avatars.githubusercontent.com/u/2799665?v=4?s=100" width="100px;" alt="Jeffrey Painter"/><br /><sub><b>Jeffrey Painter</b></sub></a><br /><a href="#data-painter1" title="Data">🔣</a> <a href="#infra-painter1" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=painter1" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/pochedls"><img src="https://avatars.githubusercontent.com/u/3698109?v=4?s=100" width="100px;" alt="Stephen Po-Chedley"/><br /><sub><b>Stephen Po-Chedley</b></sub></a><br /><a href="#data-pochedls" title="Data">🔣</a> <a href="#infra-pochedls" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="https://xylar.github.io/"><img src="https://avatars.githubusercontent.com/u/4179064?v=4?s=100" width="100px;" alt="Xylar Asay-Davis"/><br /><sub><b>Xylar Asay-Davis</b></sub></a><br /><a href="#infra-xylar" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.gfdl.noaa.gov/john-krasting-homepage"><img src="https://avatars.githubusercontent.com/u/6594675?v=4?s=100" width="100px;" alt="John Krasting"/><br /><sub><b>John Krasting</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=jkrasting" title="Code">💻</a> <a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=jkrasting" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.cgd.ucar.edu/staff/apgrass/"><img src="https://avatars.githubusercontent.com/u/16008440?v=4?s=100" width="100px;" alt="Angeline G Pendergrass"/><br /><sub><b>Angeline G Pendergrass</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=apendergrass" title="Code">💻</a> <a href="#research-apendergrass" title="Research">🔬</a> <a href="#ideas-apendergrass" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mfwehner"><img src="https://avatars.githubusercontent.com/u/10789148?v=4?s=100" width="100px;" alt="Michael Wehner"/><br /><sub><b>Michael Wehner</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=mfwehner" title="Code">💻</a> <a href="#research-mfwehner" title="Research">🔬</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://sites.google.com/uw.edu/kimresearchgroup"><img src="https://scholar.googleusercontent.com/citations?view_op=view_photo&user=3xLjsIsAAAAJ&citpid=3?s=100" width="100px;" alt="Daehyun Kim"/><br /><sub><b>Daehyun Kim</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=" title="Code">💻</a> <a href="#research" title="Research">🔬</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/bosup"><img src="https://avatars.githubusercontent.com/u/130708142?v=4?s=100" width="100px;" alt="Bo Dong"/><br /><sub><b>Bo Dong</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=bosup" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/zhangshixuan1987"><img src="https://avatars.githubusercontent.com/u/33647254?v=4?s=100" width="100px;" alt="Shixuan Zhang"/><br /><sub><b>Shixuan Zhang</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=zhangshixuan1987" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://kristinchang.github.io/portfolio/"><img src="https://avatars.githubusercontent.com/u/143142064?v=4?s=100" width="100px;" alt="Kristin Chang"/><br /><sub><b>Kristin Chang</b></sub></a><br /><a href="https://github.com/PCMDI/pcmdi_metrics/commits?author=kristinchang3" title="Code">💻</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification.