Metadata-Version: 2.4
Name: euppbench-datasets
Version: 0.2.0
Summary: Intake catalogue for the EUPPBench postprocessing datasets
Author-email: Jonathan Demaeyer <jodemaey@meteo.be>
License: BSD 3-Clause License
        
        Copyright (c) 2025, EUPP-benchmark
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/EUPP-benchmark/intake-eumetnet-postprocessing-benchmark
Project-URL: documentation, https://eupp-benchmark.github.io/EUPPBench-doc/
Keywords: meteorology,postprocessing,meteorological-data
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python>=3.10
Requires-Dist: intake>=2.0.8
Requires-Dist: intake-xarray
Requires-Dist: ipykernel>=6.29.5
Requires-Dist: jinja2>=3.1.6
Requires-Dist: s3fs>=2025.0.0
Requires-Dist: pytest
Dynamic: license-file

# The EUMETNET postprocessing benchmark dataset Intake catalogue

A Python module using [Intake](https://github.com/intake/intake) catalogues to retrieve the Eumetnet postprocessing benchmark datasets.

Ease the download of the dataset time-aligned forecasts, reforecasts (hindcasts) and observations.

> * **Climetlab plugin version**: 0.3.0
> * **Intake catalogues version**: 0.2.0
> * **Base dataset version**: 1.0
> * **EUPPBench dataset version**: 1.0
> * **EUPreciPBench dataset version**: 0.5
> * **Dataset status**: [Datasets status](https://eupp-benchmark.github.io/EUPPBench-doc/files/datasets_status.html#datasets-status)

A [climetlab plugin](https://github.com/EUPP-benchmark/climetlab-eumetnet-postprocessing-benchmark) is also available, as an alternative way to get the datasets.

## Documentation of the datasets

There are currently three sub-datasets available:

* [The base dataset over Europe's domain](https://eupp-benchmark.github.io/EUPPBench-doc/files/base_datasets.html) (available uniquely through the [climetlab plugin](https://github.com/EUPP-benchmark/climetlab-eumetnet-postprocessing-benchmark))
* [The EUPPBench dataset](https://eupp-benchmark.github.io/EUPPBench-doc/files/EUPPBench_datasets.html)
* [The EUPreciPBench dataset]()

They are documented [here](https://eupp-benchmark.github.io/EUPPBench-doc/index.html).

## Using the Intake catalogues to access the data

Access through the catalogue can be done with the Python command line interface in a few lines:

```python
# Uncomment the line below if the catalogue is not yet installed
#!pip install euppbench-datasets
import euppbench_datasets
cat = euppbench_datasets.open_catalog()
ds = cat.euppbench.training_data.gridded.EUPPBench_highres_forecasts_surface.to_dask() 
```

which download the [original EUPPBench deterministic (high-resolution) forecasts](https://eupp-benchmark.github.io/EUPPBench-doc/files/EUPPBench_datasets.html#surface-variable-forecasts) 
in the [xarray](http://xarray.pydata.org/en/stable/index.html) format.

## Support and contributing

Please open a [issue on GitHub](https://github.com/EUPP-benchmark/intake-eumetnet-postprocessing-benchmark/issues).

## LICENSE

See the [LICENSE](https://github.com/EUPP-benchmark/intake-eumetnet-postprocessing-benchmark/blob/main/LICENSE) file for the code, and the [DATA_LICENSE](https://github.com/Climdyn/climetlab-eumetnet-postprocessing-benchmark/blob/main/DATA_LICENSE) for the data.

## Authors

See the [CONTRIBUTORS.md](https://github.com/EUPP-benchmark/intake-eumetnet-postprocessing-benchmark/blob/main/CONTRIBUTORS.md) file.

## Acknowledgments

This package was inspired by the [mlcast-datasets](https://github.com/mlcast-community/mlcast-datasets) written by Leif Denby.
