Metadata-Version: 2.4
Name: climate-ref-core
Version: 0.6.4
Summary: Core library for 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 :: OS Independent
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: attrs>=23.2.0
Requires-Dist: cattrs>=24.1
Requires-Dist: environs>=11
Requires-Dist: loguru>=0.7.0
Requires-Dist: numpy>=1.25.0
Requires-Dist: pandas>=2.1.0
Requires-Dist: pooch<2,>=1.8.0
Requires-Dist: pydantic>=2.10.6
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: setuptools>=75.8.0
Requires-Dist: typing-extensions
Description-Content-Type: text/markdown

# climate-ref-core

[![PyPI version](https://badge.fury.io/py/climate-ref-core.svg)](https://badge.fury.io/py/climate-ref-core)
[![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/)

This package provides the core functionality for the Climate REF (Rapid Evaluation Framework).
It is designed as a library that can be used by other packages to implement metrics providers and extend the framework's capabilities.

## Installation


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


## Usage

This package is primarily intended to be used as a dependency by other packages implementing diagnostic providers.
See the [example diganotic provider](https://github.com/Climate-REF/climate-ref/tree/main/packages/ref-metrics-example).


## Documentation

For detailed documentation, please visit [https://climate-ref.readthedocs.io/](https://climate-ref.readthedocs.io/)

## Contributing

Contributions are welcome! Please see the main project's [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.
