Skip to main content

Climate REF (Rapid Evaluation Framework)

PyPI version Documentation Status License Python Version

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

climate_ref-0.15.0.tar.gz (375.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

climate_ref-0.15.0-py3-none-any.whl (227.6 kB view details)

Uploaded Python 3

File details

Details for the file climate_ref-0.15.0.tar.gz.

File metadata

  • Download URL: climate_ref-0.15.0.tar.gz
  • Upload date:
  • Size: 375.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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}

File hashes

Hashes for climate_ref-0.15.0.tar.gz
Algorithm Hash digest
SHA256 5483d9d8890b6fbdf12606ecb0c4d2a142d8c8592427c886def692b19e614a47
MD5 1b305c7761caece924901428fdf5e2ab
BLAKE2b-256 44d0ce11c414d3328e52904e0a9518bb20037af3c9301952d4101ad21b55e9db

See more details on using hashes here.

File details

Details for the file climate_ref-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: climate_ref-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 227.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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}

File hashes

Hashes for climate_ref-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd64229f9b0bd775edcc9f0b6d84385de2f36df1d4409fe6285d1284d56d4bec
MD5 ec98ca7127036a69086fe68257ca29c6
BLAKE2b-256 0851fcb5fe775775fc5078ea3c70780e1dc887a938ed57a845f1a9e341ddc510

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page