Metadata-Version: 2.4
Name: climate-ref
Version: 0.6.5
Summary: Application which runs the CMIP Rapid Evaluation Framework
Author-email: Jared Lewis <jared.lewis@climate-resource.com>, Mika Pflueger <mika.pflueger@climate-resource.com>, Bouwe Andela <b.andela@esciencecenter.nl>, Jiwoo Lee <lee1043@llnl.gov>, Min Xu <xum1@ornl.gov>, Nathan Collier <collierno@ornl.gov>, Dora Hegedus <dora.hegedus@stfc.ac.uk>
License-Expression: Apache-2.0
License-File: LICENCE
License-File: NOTICE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: alembic>=1.13.3
Requires-Dist: attrs>=24.2.0
Requires-Dist: cattrs>=24.1.2
Requires-Dist: climate-ref-core
Requires-Dist: ecgtools>=2024.7.31
Requires-Dist: environs>=11.0.0
Requires-Dist: loguru>=0.7.2
Requires-Dist: parsl>=2025.5.19; sys_platform != 'win32'
Requires-Dist: platformdirs>=4.3.6
Requires-Dist: sqlalchemy>=2.0.36
Requires-Dist: tomlkit>=0.13.2
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typer>=0.12.5
Provides-Extra: aft-providers
Requires-Dist: climate-ref-esmvaltool>=0.5.0; extra == 'aft-providers'
Requires-Dist: climate-ref-ilamb>=0.5.0; extra == 'aft-providers'
Requires-Dist: climate-ref-pmp>=0.5.0; extra == 'aft-providers'
Provides-Extra: celery
Requires-Dist: climate-ref-celery>=0.5.0; extra == 'celery'
Provides-Extra: postgres
Requires-Dist: alembic-postgresql-enum>=1.7.0; extra == 'postgres'
Requires-Dist: psycopg2-binary>=2.9.2; extra == 'postgres'
Provides-Extra: providers
Requires-Dist: climate-ref-esmvaltool>=0.5.0; extra == 'providers'
Requires-Dist: climate-ref-ilamb>=0.5.0; extra == 'providers'
Requires-Dist: climate-ref-pmp>=0.5.0; extra == 'providers'
Description-Content-Type: text/markdown

# Climate REF (Rapid Evaluation Framework)

[![PyPI version](https://badge.fury.io/py/climate-ref.svg)](https://badge.fury.io/py/climate-ref)
[![Documentation Status](https://readthedocs.org/projects/climate-ref/badge/?version=latest)](https://climate-ref.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)

**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

```bash
pip install climate-ref
```

If you want to use the diagnostic providers for the Assessment Fast Track, you can install them with:

```bash
pip install climate-ref[aft-providers]
```

## Quick Start

```bash
# 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/](https://climate-ref.readthedocs.io/)

## Contributing

REF is a community project, and we welcome contributions from anyone. Please see our [Contributing Guide](https://climate-ref.readthedocs.io/en/latest/contributing/) for more information.

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
