PCMDI Metrics Package

Open-source Python package for Systematic Evaluation of Climate and Earth System Models.
https://github.com/pcmdi/pcmdi_metrics

Category: Climate Change
Sub Category: Earth and Climate Modeling

Keywords

climate climate-analysis climate-data climate-model climate-model-evaluation climate-models climate-science climate-variability python

Keywords from Contributors

cdat earthscience vtk cmip6 esgf simulator climate-data-analysis xcdat photovoltaic composer

Last synced: about 13 hours ago
JSON representation

Repository metadata

Open-source Python package for Systematic Evaluation of Climate and Earth System Models

Host: GitHub
URL: https://github.com/pcmdi/pcmdi_metrics
Owner: PCMDI
License: bsd-3-clause
Created: 2013-05-28T20:48:38.000Z (almost 12 years ago)
Default Branch: main
Last Pushed: 2025-04-17T18:30:24.000Z (9 days ago)
Last Synced: 2025-04-17T22:45:38.493Z (9 days ago)
Topics: climate, climate-analysis, climate-data, climate-model, climate-model-evaluation, climate-models, climate-science, climate-variability, python
Language: Python
Homepage: http://pcmdi.github.io/pcmdi_metrics/
Size: 626 MB
Stars: 108
Watchers: 9
Forks: 42
Open Issues: 39
Releases: 47
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Support: docs/supporting-data.rst

PCMDI Metrics Package (PMP)

Conda-forge (CURRENT, recommended):

PCMDI Conda Channel (old, deprecated):

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:

Analysis software
Observation-based reference database of global (or near global, land or ocean) time series and climatologies
Package documentation and interactive jupyter notebook demos
Database of performance metrics computed for CMIP models

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

References

Latest:

Lee, J., Gleckler, P. J., Ahn, M.-S., Ordonez, A., Ullrich, P. A., Sperber, K. R., Taylor, K. E., Planton, Y. Y., Guilyardi, E., Durack, P., Bonfils, C., Zelinka, M. D., Chao, L.-W., Dong, B., Doutriaux, C., Zhang, C., Vo, T., Boutte, J., Wehner, M. F., Pendergrass, A. G., Kim, D., Xue, Z., Wittenberg, A. T., and Krasting, J.: Systematic and objective evaluation of Earth system models: PCMDI Metrics Package (PMP) version 3, Geosci. Model Dev., 17, 3919–3948, https://doi.org/10.5194/gmd-17-3919-2024, 2024.

Earlier versions:

Gleckler, P. J., Doutriaux, C., Durack, P. J., Taylor, K. E., Zhang, Y., Williams, D. N., Mason, E., and Servonnat, J.: A more powerful reality test for climate models, Eos T. Am. Geophys. Un., 97, https://doi.org/10.1029/2016eo051663, 2016.
Gleckler, P. J., Taylor, K. E., and Doutriaux, C.: Performance metrics for climate models, J. Geophys. Res., 113, D06104, https://doi.org/10.1029/2007jd008972, 2008.

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.

LLNL-CODE-2004137

DOE CODE ID: #153383

License

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

Release Notes and History

Versions	Update summary
v3.9.1	New capability (new modes for modes of variability metrics: EA, SCA) and technical update
v3.9	New capability (Decision-Relevant metrics, Database access API) and new demo notebooks
v3.8.2	Technical update
v3.8.1	Technical update with new figure (modes of variability multi-panel plot)
v3.8	New capability (figure generation for ENSO, xCDAT migration completed for Monsoon Wang with figure generation), major dependency update (`numpy` >= 2.0)
v3.7.2	Technical update
v3.7.1	Technical update with documentation improvements
v3.7	New capability (figure generation for mean climate) and technical update
v3.6.1	Technical update, additional QC repair functions
v3.6	New capability (regional application of precip variability) and technical update
v3.5.2	New capability (QC, new modes for modes of variability metrics: PSA1, PSA2) and technical update
v3.5.1	Technical update
v3.5	Technical update: MJO and Monsoon Sperber xCDAT conversion
v3.4.1	Technical update
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

Versions	Update summary
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

Current Core Development Team

All Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: PCMDI Metrics Package
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jiwoo
    family-names: Lee
    email: [email protected]
    affiliation: Lawrence Livermore National Laboratory
    orcid: 'https://orcid.org/0000-0002-0016-7199'
  - family-names: Gleckler
    given-names: Peter
    affiliation: Lawrence Livermore National Laboratory
    orcid: 'https://orcid.org/0000-0003-2816-6224'
  - family-names: Ordonez
    given-names: Ana
    affiliation: Lawrence Livermore National Laboratory
  - given-names: Bo
    family-names: Dong
    affiliation: Lawrence Livermore National Laboratory
  - affiliation: Lawrence Livermore National Laboratory
    given-names: Kristin
    family-names: Chang
  - given-names: Paul
    family-names: Ullrich
    affiliation: Lawrence Livermore National Laboratory and UC Davis
    orcid: 'https://orcid.org/0000-0003-4118-4590'
identifiers:
  - type: doi
    value: 10.5281/zenodo.592790
    description: Software
repository-code: 'https://github.com/PCMDI/pcmdi_metrics'
url: 'http://pcmdi.github.io/pcmdi_metrics/'
abstract: ' Open-source Python package for Systematic Evaluation of Climate and Earth System Models '
keywords:
  - climate
  - climate modeling
  - climate model evaluation
  - Earth System Model evaluation
  - climatology
  - climate variability
license: BSD-3-Clause
version: '3.9.1'
date-released: '2025-04-10'

Owner metadata

Name: Program for Climate Model Diagnosis and Intercomparison
Login: PCMDI
Email: [email protected]
Kind: organization
Description: Established in 1989, PCMDI aims to develop advanced methods and tools for diagnosis and intercomparison to improve Earth System and Climate Models
Website: http://pcmdi.llnl.gov
Location: Lawrence Livermore National Lab
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/6098305?v=4
Repositories: 45
Last ynced at: 2024-03-26T10:12:39.209Z
Profile URL: https://github.com/PCMDI

GitHub Events

Total

Create event: 100
Commit comment event: 2
Release event: 9
Delete event: 84
Member event: 2
Pull request event: 177
Fork event: 4
Issues event: 67
Watch event: 9
Issue comment event: 188
Push event: 583
Gollum event: 5
Pull request review comment event: 5
Pull request review event: 35

Last Year

Create event: 100
Commit comment event: 2
Release event: 9
Delete event: 84
Member event: 2
Pull request event: 177
Fork event: 4
Issues event: 67
Watch event: 9
Issue comment event: 188
Push event: 583
Gollum event: 5
Pull request review comment event: 5
Pull request review event: 35

Committers metadata

Last synced: 4 days ago

Total Commits: 3,965
Total Committers: 40
Avg Commits per committer: 99.125
Development Distribution Score (DDS): 0.533

Commits in past year: 737
Committers in past year: 14
Avg Commits per committer in past year: 52.643
Development Distribution Score (DDS) in past year: 0.362

Name	Email	Commits
Jiwoo Lee	l**3@l**v	1853
Charles Doutriaux	d**1@l**v	576
Ana Ordonez	o**4@l**v	381
Ana Ordonez	a**z@c**t	368
Peter Gleckler	g**1@l**v	177
Paul J. Durack	d**1@l**v	172
zshaheen	z**3@g**m	112
Min-Seop Ahn	a**6@l**v	63
Peter Gleckler	g**1@g**v	31
muryanto1	m**1@l**v	25
Bo Dong postdoc	d**n@h**m	24
Tom Vo	t**r@g**m	22
Jason Boutte	b**n@g**m	20
Min-Seop Ahn	4****n	20
Kristin Chang	c**1@l**v	15
Muryanto	m**1@m**v	14
Muryanto	m**1@M**v	12
ShixuanZhang	s**g@p**v	10
allcontributors[bot]	4****]	10
Peter Gleckler	g**1@c**v	10
omahs	7****s	7
mzelinka	z**1@l**v	7
Jeff Painter	p**1@l**v	6
Peter Gleckler	g**1@o**v	5
Jeff Painter	p**1@o**v	4
Paul Durack	p**d@p**)	3
jeffrey Painter	p**1@p**v	3
Lina Muryanto	3****1	2
mfwehner	m**r@l**v	2
Alex Jonko	a**o@l**v	1
and 10 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 149
Total pull requests: 366
Average time to close issues: 9 months
Average time to close pull requests: 23 days
Total issue authors: 15
Total pull request authors: 15
Average comments per issue: 1.64
Average comments per pull request: 1.67
Merged pull request: 326
Bot issues: 0
Bot pull requests: 5

Past year issues: 63
Past year pull requests: 183
Past year average time to close issues: 27 days
Past year average time to close pull requests: 7 days
Past year issue authors: 10
Past year pull request authors: 9
Past year average comments per issue: 1.16
Past year average comments per pull request: 1.32
Past year merged pull request: 166
Past year bot issues: 0
Past year bot pull requests: 3

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/pcmdi/pcmdi_metrics

Top Issue Authors

lee1043 (89)
gleckler1 (15)
acordonez (14)
msahn (6)
durack1 (5)
ShihengDuan (5)
kristinchang3 (4)
zhangshixuan1987 (3)
doutriaux1 (2)
bouweandela (1)
xylar (1)
tomvothecoder (1)
dnadeau4 (1)
ajonko (1)
bosup (1)

Top Pull Request Authors

lee1043 (258)
acordonez (61)
msahn (7)
durack1 (7)
gleckler1 (6)
kristinchang3 (5)
zhangshixuan1987 (5)
allcontributors[bot] (5)
mzelinka (3)
bosup (3)
jasonb5 (2)
doutriaux1 (1)
ajonko (1)
tomvothecoder (1)
omahs (1)

Top Issue Labels

enhancement (31)
New feature (18)
bug (16)
doc (12)
graphic (7)
feature request (5)
build (2)
demo (2)
duplicate (1)
QC (1)
clean up (1)

Top Pull Request Labels

doc (73)
enhancement (54)
bug (31)
demo (27)
minor (25)
New feature (23)
graphic (17)
clean up (11)
build (9)
feature request (5)
workflow (4)
CRITICAL (3)
QC (2)
TOPPRIORITY (1)
DecisionNeededNow (1)

Package metadata

Total packages: 2
Total downloads:
- pypi: 361 last-month
Total dependent packages: 0 (may contain duplicates)
Total dependent repositories: 0 (may contain duplicates)
Total versions: 11
Total maintainers: 1

pypi.org: cmip_ref_metrics_pmp

PMP metrics provider for the CMIP Rapid Evaluation Framework

Homepage:
Documentation: https://cmip_ref_metrics_pmp.readthedocs.io/
Licenses: Apache-2.0
Latest release: 0.3.1 (published 29 days ago)
Last Synced: 2025-04-25T13:05:53.608Z (1 day ago)
Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 361 Last month
Rankings:
- Dependent packages count: 9.677%
- Average: 32.08%
- Dependent repos count: 54.484%
Maintainers (1)
- JaredLewis

conda-forge.org: pcmdi_metrics

model metrics tools

Homepage: http://github.com/PCMDI/pcmdi_metrics
Licenses: BSD-3-Clause
Latest release: 2.5.1 (published over 2 years ago)
Last Synced: 2025-04-01T02:08:47.008Z (26 days ago)
Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Forks count: 28.545%
- Dependent repos count: 34.025%
- Stargazers count: 35.643%
- Average: 37.347%
- Dependent packages count: 51.175%

Dependencies

.github/workflows/build_workflow.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/setup-python v2 composite
conda-incubator/setup-miniconda v2 composite
fkirc/skip-duplicate-actions master composite
pre-commit/action v2.0.3 composite

Score: 14.570956252718444

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology