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.16.2.tar.gz (461.3 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.16.2-py3-none-any.whl (286.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: climate_ref-0.16.2.tar.gz
  • Upload date:
  • Size: 461.3 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.16.2.tar.gz
Algorithm Hash digest
SHA256 9fc49f577d554192a1858a3d3c6b6e8cdf2cef88a5c73589a9f1a761d323f1c1
MD5 2172380d5e588e84724e2cbc0c60333d
BLAKE2b-256 af38a8e62e75cadda4d00b303e410c0f2cb9a947c3aeb35a5557f1cefc395946

See more details on using hashes here.

File details

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

File metadata

  • Download URL: climate_ref-0.16.2-py3-none-any.whl
  • Upload date:
  • Size: 286.9 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.16.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5184ba648bc194ef925595bd4d61f4d52cc930c673362b8c0189d27ad981bb5
MD5 92c5e3759917dda3862c5e730d763987
BLAKE2b-256 67003ee8347c591b7ca534f7b249da89ade7bc89078688267054e06e680c6118

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