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[aft-providers]"
Quick Start
# Ingest some observation datasets
ref datasets fetch-data --registry obs4ref --output-directory datasets/obs4ref
ref datasets fetch-data --registry sample-data --output-directory 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.
2 maintainers
Metadata
2 maintainers
Release files for climate-ref 0.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| climate_ref-0.18.0.tar.gz | 560.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| climate_ref-0.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 909.2 kB
Release files / climate_ref-0.18.0.tar.gz
| Download URL | climate_ref-0.18.0.tar.gz |
|---|---|
| Size | 560.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f39c24ca6fe15bab46d81734b61f6dbda1945da5a310ae99cd122fc3e4e1341c
|
|
BLAKE2b-256 checksum How to use checksums |
a73b5227a9b527b89c917927c9c779e50ec96e31fecafc171b2a1aa6a93b534a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / climate_ref-0.18.0-py3-none-any.whl
| Download URL | climate_ref-0.18.0-py3-none-any.whl |
|---|---|
| Size | 349.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f5cff6ea6b10355eba170419e3c76b7bd796412b269364a71d46e210d9626176
|
|
BLAKE2b-256 checksum How to use checksums |
540de89232a53a8ed24a3b1e69012030ffdc9ceb63b62eae8017591980e9b33f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
