-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,21 @@ | ||
<img src="share/pcmdi/PMPLogo_1359x1146px_300dpi.png" width="15%" height="15%" align="right" /> | ||
<h5 align="right"></h5> | ||
|
||
PCMDI Metrics Package (PMP) | ||
====== | ||
# PCMDI Metrics Package (PMP) | ||
|
||
[![latest version](https://anaconda.org/conda-forge/pcmdi_metrics/badges/version.svg)](https://anaconda.org/conda-forge/pcmdi_metrics/) | ||
![Last updated](https://anaconda.org/conda-forge/pcmdi_metrics/badges/latest_release_date.svg) | ||
![platforms](https://img.shields.io/badge/platforms-linux%20|%20osx-lightgrey.svg) | ||
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.592790.svg)](https://doi.org/10.5281/zenodo.592790) | ||
![License](https://anaconda.org/conda-forge/pcmdi_metrics/badges/license.svg) | ||
[![License](https://anaconda.org/conda-forge/pcmdi_metrics/badges/license.svg)](https://github.com/PCMDI/pcmdi_metrics/blob/main/LICENSE) | ||
[![Formatted with black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) | ||
|
||
Conda-forge (NEW, recommended): | ||
![Install](https://anaconda.org/conda-forge/pcmdi_metrics/) | ||
[![Download](https://anaconda.org/conda-forge/pcmdi_metrics/badges/downloads.svg)](https://anaconda.org/conda-forge/pcmdi_metrics/) | ||
|
||
PCMDI Conda Channel (halted): | ||
[![Download](https://anaconda.org/pcmdi/pcmdi_metrics/badges/downloads.svg)](https://anaconda.org/pcmdi/pcmdi_metrics) | ||
|
||
|
||
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](https://cmec.llnl.gov/results/physical.html)** | ||
|
@@ -28,17 +27,40 @@ The package expects model data to be [CF-compliant](http:https://cfconventions.org/). | |
Users will need to contact the PMP developers ([email protected]) to obtain supporting datasets and get started using the package. | ||
|
||
|
||
GETTING STARTED | ||
---------------- | ||
## Documentation | ||
|
||
Installation requirements and instructions are available on the [Install](http:https://pcmdi.github.io/pcmdi_metrics/install.html) page | ||
Getting Started: Installation requirements and instructions are available on the [Install](http:https://pcmdi.github.io/pcmdi_metrics/install.html) page | ||
|
||
An overview for using the package and template scripts are detailed on the [Using-the-package](http:https://pcmdi.github.io/pcmdi_metrics) page | ||
|
||
[View Demo](https://github.com/PCMDI/pcmdi_metrics/blob/main/doc/jupyter/Demo/README.md) | ||
|
||
|
||
## Contact | ||
|
||
[Report Bug](https://github.com/PCMDI/pcmdi_metrics/issues) | ||
|
||
[Request Feature](https://github.com/PCMDI/pcmdi_metrics/issues) | ||
|
||
Some installation support for CMIP participating modeling groups is available: [email protected] | ||
|
||
[PMP versions](https://github.com/PCMDI/pcmdi_metrics/releases) | ||
------------ | ||
|
||
## Contributors | ||
|
||
Thanks to our contributors! | ||
|
||
[![Contributors](https://contrib.rocks/image?repo=PCMDI/pcmdi_metrics)](https://github.com/PCMDI/pcmdi_metrics/graphs/contributors) | ||
|
||
|
||
## License | ||
|
||
Distributed under the BSD 3-Clause License. See [`LICENSE`](https://github.com/PCMDI/pcmdi_metrics/blob/main/LICENSE) for more information. | ||
|
||
|
||
## Version Release Log | ||
|
||
[Released versions](https://github.com/PCMDI/pcmdi_metrics/releases) | ||
|
||
- [v2.5.0](https://github.com/PCMDI/pcmdi_metrics/releases/tag/v2.5.0) - New metric added: Precipitation Benchmarking -- distribution. Graphics updated | ||
- [v2.4.0](https://github.com/PCMDI/pcmdi_metrics/releases/tag/v2.4.0) - New metric added: AMO in variability modes | ||
- [v2.3.2](https://github.com/PCMDI/pcmdi_metrics/releases/tag/v2.3.2) - CMEC interface updates | ||
|