Skip to content

PCMDI/pcmdi_metrics

Repository files navigation

PCMDI Metrics Package (PMP)

latest version Last updated platforms DOI License Formatted with black

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, and high frequency characteristics of simulated precipitation.

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

The metrics package consists of four parts: 1) Analysis software, 2) an observationally-based database of global (or near global, land or ocean) time series and climatologies, 3) a database of performance metrics computed for CMIP models and 4) package documentation and interactive demos.

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.

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

Documentation

Getting Started: Installation requirements and instructions are available on the Install page

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

View Demo

Contact

Report Bug

Request Feature

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

Contributors

Thanks to our contributors!

Contributors

License

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

Version Release Log

Released versions

  • 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. Now includes extensive regression testing. 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.