climate-ref-example
This package provides an example implementation of a diagnostic provider for the Climate REF (Rapid Evaluation Framework). It serves as a template and reference for developers who want to create their own diagnostic providers.
Installation
pip install climate-ref-example
Features
- Example implementation of a diagnostic provider
- Global mean timeseries diagnostic demonstration
- Complete implementation of all required interfaces
- Test data specification for reproducible testing
Usage
Enable the provider in your ref.toml configuration:
[[diagnostic_providers]]
provider = "climate_ref_example:provider"
Then run diagnostics:
ref solve --provider example
Example Diagnostic
The package implements a GlobalMeanTimeseries diagnostic that calculates the annual mean global mean timeseries for CMIP6 datasets:
from climate_ref_core.providers import DiagnosticProvider
from climate_ref_core.diagnostics import Diagnostic, DataRequirement, ExecutionDefinition, ExecutionResult
from climate_ref_core.datasets import FacetFilter, SourceDatasetType
class GlobalMeanTimeseries(Diagnostic):
"""Calculate the annual mean global mean timeseries for a dataset."""
name = "Global Mean Timeseries"
slug = "global-mean-timeseries"
data_requirements = (
DataRequirement(
source_type=SourceDatasetType.CMIP6,
filters=(FacetFilter(facets={"variable_id": ("tas", "rsut")}),),
group_by=("source_id", "variable_id", "experiment_id", "variant_label"),
),
)
facets = ("source_id", "variable_id", "experiment_id", "variant_label", "region", "metric", "statistic")
def execute(self, definition: ExecutionDefinition) -> None:
# Perform the diagnostic calculation
...
def build_execution_result(self, definition: ExecutionDefinition) -> ExecutionResult:
# Build and return the execution result
...
# Register diagnostics with a provider
provider = DiagnosticProvider("Example", __version__)
provider.register(GlobalMeanTimeseries())
Creating Your Own Provider
Use this package as a template:
cp -r packages/climate-ref-example packages/climate-ref-myprovider
See the Adding Custom Diagnostics guide for detailed instructions.
Documentation
For detailed documentation, please visit https://climate-ref.readthedocs.io/
Contributing
Contributions are welcome! Please see the main project's Contributing Guide for more information.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for climate-ref-example 0.20.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| climate_ref_example-0.20.1.tar.gz | 24.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| climate_ref_example-0.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.0 kB
Release files / climate_ref_example-0.20.1.tar.gz
| Download URL | climate_ref_example-0.20.1.tar.gz |
|---|---|
| Size | 24.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
391e9f5f7780302261ae5ef1c53795696d44bfb9427d1fc986abbc266dc884b8
|
|
BLAKE2b-256 checksum How to use checksums |
6ab4fabc8a3696024964fc46ece2f0616eb3e1ff25fae1c631d4b28af70e6429
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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}
|
Release files / climate_ref_example-0.20.1-py3-none-any.whl
| Download URL | climate_ref_example-0.20.1-py3-none-any.whl |
|---|---|
| Size | 15.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
721bf76da5eeeb69061b5a16dd3d6aa1edda212f6e94d8cc9efd580ab09abe08
|
|
BLAKE2b-256 checksum How to use checksums |
48a8fe14b7a8bf98520e259597bd296ca7e9a6e09ccff767e862bcfa4a3c9b36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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}
|
Security for climate-ref-example 0.20.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
