Metadata-Version: 2.4
Name: hereon-evasuite
Version: 1.0.4
Summary: EvaSuite (Evaluation Suite for climate data): a framework for evaluation and visualization of regional climate model simulations
Author-email: EvaSuite Development Team <imktro-climate-modelling@lists.kit.edu>
License: Apache-2.0
Project-URL: Homepage, https://gitlab.dkrz.de/clm-community/public/evasuite
Project-URL: Repository, https://gitlab.dkrz.de/clm-community/public/evasuite
Project-URL: Documentation, https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/DOCS
Project-URL: Zenodo, https://doi.org/10.5281/zenodo.19223685
Keywords: climate,evaluation,xarray,netcdf,visualization,geoscience,rcm,hpc
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: <3.11,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.TXT
Requires-Dist: cartopy==0.24.1
Requires-Dist: cdo==1.6.0
Requires-Dist: cftime==1.6.3
Requires-Dist: dask==2024.4.1
Requires-Dist: distributed==2024.4.1
Requires-Dist: geopandas==0.14.3
Requires-Dist: h5py==3.11.0
Requires-Dist: jinja2==3.1.3
Requires-Dist: matplotlib==3.8.4
Requires-Dist: netcdf4==1.6.5
Requires-Dist: numba==0.59.1
Requires-Dist: numpy==1.26.4
Requires-Dist: pandas==2.2.2
Requires-Dist: psutil==5.9.8
Requires-Dist: pyproj==3.6.1
Requires-Dist: pyyaml==6.0.1
Requires-Dist: regionmask==0.12.1
Requires-Dist: scipy==1.13.0
Requires-Dist: shapely==2.0.3
Requires-Dist: statsmodels==0.14.1
Requires-Dist: xarray==2024.3.0
Requires-Dist: xhistogram==0.3.2
Requires-Dist: xskillscore==0.0.26
Requires-Dist: fiona==1.9.6
Provides-Extra: dev
Requires-Dist: pytest==8.1.1; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Dynamic: license-file

# EvaSuite – Evaluation Suite for Climate Data

![EvaSuite Logo](https://gitlab.dkrz.de/clm-community/public/evasuite/-/raw/main/DOCS/assets/LOGO_small.png)

- [**Documentation**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/)
- [**Installation**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/05_installation/)
- [**Configuration**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/06_configuration/)
- [**Running EvaSuite**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/07_running/)
- [**Examples**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/11_examples/)
- [**FAQ**](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/12_faq/)
- [**EvaSuite Test Data**](https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/EXAMPLE/DATA?ref_type=heads)
- [**EvaSuite Extensions**](https://gitlab.dkrz.de/clm-community/public/evasuite-addons)


## Introduction

**Evaluation Suite (EvaSuite)** is a modular software framework for the standardised evaluation of regional climate model (RCM) simulations against observational and reference datasets, including model sensitivity analysis. It is designed for high-performance computing platforms and addresses the need for transparent, reproducible, and flexible evaluation workflows for RCMs. EvaSuite combines data harmonisation, spatial and temporal remapping, statistical evaluation, and visualisation within a unified **fully configurable, end-to-end workflow**. EvaSuite is maintained by the [CLM-Community](https://www.clm-community.eu/) and is designed for reproducible use on HPC systems as well as on local workstations (under developing).

All evaluation workflows are controlled through **YAML configuration files** defining:

- system settings and external dependencies;
- model and reference datasets;
- preprocessing options;
- evaluation metrics;
- visualisation settings.

For the complete user documentation, see the [EvaSuite documentation](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/).

## Key Features

- **End-to-end evaluation workflow**
  - Data harmonisation, remapping, metric computation and visualisation.
- **YAML-driven configuration**
  - Reproducible and automation-friendly workflows.
- **HPC-ready design**
  - Supports direct execution, interactive use and SLURM batch submission.
- **Local execution**
  - Simple examples can also be run on a local workstation with local dataset catalogues.
- **Flexible data support**
  - CF-compliant NetCDF datasets from models, reanalyses and observations.
- **Advanced diagnostics**
  - Bias, RMSE, correlation, quantile-based diagnostics, significance testing and other evaluation metrics.
- **Integrated visualisation**
  - Maps, time series, QQ plots and Taylor diagrams.
- **Modular extensions**
  - Additional tools and workflows are maintained in separate EvaSuite extension projects.

## General Information
The [history and recent updates](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/) of EvaSuite provide an overview of the framework evolution and newly introduced features. Detailed instructions for installation and system setup are described in the [Installation Guide](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/05_installation/), including environment preparation and known issues. EvaSuite can be executed in different modes (main, interactive, debug), as explained in the [running documentation](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/07_running/), allowing flexible usage for both batch HPC workflows and exploratory analysis. User-specific customization of plots, maps, and diagnostics is controlled via configuration files, documented in the user settings sections for [plots](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/06_configuration/), [maps](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/06_configuration/) and [Taylor diagrams](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/06_configuration/). A comprehensive collection of reproducible workflows is available in the [examples](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/11_examples/), demonstrating typical evaluation setups and wrapper-based pipelines. Additional technical details, module descriptions, and theoretical background are provided in the [full documentation](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/). For advanced applications and extensions (e.g. SPICE workflows), see the dedicated [SPICE documentation](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/spice/README.md?ref_type=heads). Modular extensions presented in separate projects [GeoPackage](https://gitlab.dkrz.de/clm-community/public/evasuite-addons/evasuite_geopackage), [GriddedStations](https://gitlab.dkrz.de/clm-community/public/evasuite-addons/evasuite_gridded_stations), [ScoPi](https://gitlab.dkrz.de/clm-community/public/evasuite-addons/evasuite_scopi) and [UrbanPlot](https://pypi.org/project/urbanplot/)


## Getting help

Before opening an issue, check:

- the [documentation](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/);
- the [FAQ](https://clm-community.gitlab-pages.dkrz.de/public/evasuite/12_faq/).

If the problem remains unresolved, open an [issue on GitLab](https://gitlab.dkrz.de/clm-community/public/evasuite/-/issues?sort=created_date&state=opened&first_page_size=100).


## Citation

If you use **EvaSuite** in your research, please cite:

> Petrik, R., Geyer, B., Churiulin, E., Rockel, B., & Braun, C. (2026).
> *EvaSuite (Evaluation Suite for climate data).*
> Zenodo. https://doi.org/10.5281/zenodo.19223685

### BibTeX

```bibtex
@software{petrik2026evasuite,
  author       = {Petrik, Ronny and Geyer, Beate and Churiulin, Evgenii and Rockel, Burkhardt and Braun, Christoph},
  title        = {EvaSuite (Evaluation Suite for climate data)},
  year         = {2026},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.19223685},
  url          = {https://doi.org/10.5281/zenodo.19223685}
}
```


## Contributing
Contributions of new diagnostics, workflows and features are welcome. Please follow the CLM-Community development and contribution conventions and coordinate larger changes through the project issue tracker.
