climate-ref 0.5.1

Application which runs the CMIP Rapid Evaluation Framework

Climate REF (Rapid Evaluation Framework)

Status: This project is in active development. We expect to be ready for beta releases in Q2 2025.

The Rapid Evaluation Framework (REF) is a set of Python packages that provide the ability to manage the execution of calculations against climate datasets. The aim is to be able to evaluate climate data against a set of reference data in near-real time as datasets are published, and to update any produced data and figures as new datasets become available. This is somewhat analogous to a CI/CD pipeline for climate data.

Installation

pip install climate-ref

If you want to use the diagnostic providers for the Assessment Fast Track, you can install them with:

pip install climate-ref[metrics]

Quick Start

# Ingest some observation datasets
ref datasets fetch-data --registry obs4ref --output-dir datasets/obs4ref
ref datasets fetch-data --registry sample-data --output-dir datasets/sample-data

# Run metrics against your climate data
ref solve

Features

• Real-time evaluation of climate datasets
• Support for multiple metrics providers (PMP, ILAMB, ESMValTool)
• Distributed processing capabilities
• Extensible architecture for adding new metrics providers
• Command-line interface for easy interaction

Documentation

For detailed documentation, please visit https://climate-ref.readthedocs.io/

Contributing

REF is a community project, and we welcome contributions from anyone. Please see our Contributing Guide for more information.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.