Climate REF (Rapid Evaluation Framework)
Looking for results? Evaluations of CMIP7 data are published on the REF dashboard. This documentation is for people running the REF or developing diagnostics for it.
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.20.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 | Provenance | |
|---|---|---|---|---|
| climate_ref-0.20.0.tar.gz | 649.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| climate_ref-0.20.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / climate_ref-0.20.0.tar.gz
| Download URL | climate_ref-0.20.0.tar.gz |
|---|---|
| Size | 649.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cc699f8dd646f81f0a6fec0a54b5473ff69d706d0d39e6f0c54ec1117a087e3a
|
|
BLAKE2b-256 checksum How to use checksums |
e66a8dea166923be6ed91aa1462f4909fcc20ed9e1c752aa227736350412933a
|
| 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.20.0-py3-none-any.whl
| Download URL | climate_ref-0.20.0-py3-none-any.whl |
|---|---|
| Size | 406.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b0baaa05e1193c10d6fd3e387f32ec0ce8ba894c40b23ed841714af080738101
|
|
BLAKE2b-256 checksum How to use checksums |
7234e80f37ba0cb7e83e0cffd1545a6a57fb0d27a4202a10a0699d0dd1276cdc
|
| 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}
|
Security for climate-ref 0.20.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
