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.14.7.tar.gz (320.4 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.14.7-py3-none-any.whl (191.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: climate_ref-0.14.7.tar.gz
  • Upload date:
  • Size: 320.4 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.14.7.tar.gz
Algorithm Hash digest
SHA256 855e17c127f5af5aa7311ff31ca8d725d35fc40c9da570c151922f9d59d4a070
MD5 2defae37d621f953b7189ef038784e0d
BLAKE2b-256 75d3e54059dc8721e25ae63e53d39b2cf3859059fbf2becd8136d9ffec85a788

See more details on using hashes here.

File details

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

File metadata

  • Download URL: climate_ref-0.14.7-py3-none-any.whl
  • Upload date:
  • Size: 191.2 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.14.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fae9fb09a85aa09aabe69657c84a94007934016f237b5b1463bf120d0651c545
MD5 5d3038f6e7d6143a286e4283482c0902
BLAKE2b-256 1ef45a429610ddcf8eef3883fe6bd39b4acc62c4f8d689f547ece38f005d9fd1

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