Metadata-Version: 2.4
Name: hereon-evasuite
Version: 0.0.4
Summary: EvaSuite (Evaluation Suite for climate data)
Home-page: 
Author: Evgenii Churiulin
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: Zenodo, https://zenodo.org/records/19223685
Project-URL: Documentation, https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/DOCS?ref_type=heads
Keywords: climate,evaluation,xarray,visualization,geoscience
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: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
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: author
Dynamic: license-file
Dynamic: requires-python

# EvaSuite – Evaluation Suite for Climate Data

![EvaSuite Logo](DOCS/LOGO/LOGO.png)

- [**Documentation**](https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/DOCS?ref_type=heads)
- [**EvaSuite Installation**](https://tutorial.esmvaltool.org/index.html)
- [**EvaSuite Examples**](https://github.com/ESMValGroup)
- [**EvaSuite Test Data**](https://github.com/ESMValGroup)
- [**EvaSuite Extensions**]()

## 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 an open-source evaluation framework maintained by the [CLM-Community](https://www.clm-community.eu/). It provides a  covering preprocessing, regridding, statistical evaluation, and visualization.

All evaluation workflows in EvaSuite are controlled via **YAML configuration files**, which define:

- the system settings (external dependencies)
- the input datasets (model simulations and reference observations)
- preprocessing steps (e.g. regridding, masking, temporal aggregation)
- evaluation metrics (e.g. bias, RMSE, correlation, quantiles)
- visualization settings (maps, time series, Taylor diagrams)

 For a comprehensive introduction to EvaSuite please visit our [documentation](https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/DOCS?ref_type=heads) page.

## Key Features

- **End-to-end evaluation workflow**
  - Data harmonisation, regridding, metric computation, visualisation
- **YAML-driven configuration**
  - Fully reproducible and automation-friendly workflows
- **HPC-ready design**
  - Optimised for SLURM-based execution and batch processing
- **Flexible data support**
  - CF-compliant NetCDF datasets (models, reanalysis, observations)
- **Advanced diagnostics**
  - Bias, RMSE, correlation, quantile-based metrics, significance testing
- **Integrated visualisation**
  - Maps, time series, QQ plots, Taylor diagrams
- **Modular extensions**
  - GeoPackage, GriddedStations, ScoPi, PlotSmart, UrbanPlot

## General Information
The [history and recent updates](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/New_updates.md?ref_type=heads) 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://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/Installation.md?ref_type=heads), including environment preparation and known issues. EvaSuite can be executed in different modes (main, interactive, debug), as explained in the [running documentation](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/Running.md?ref_type=heads), 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://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/Plots_user_settings.md?ref_type=heads), [maps](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/Maps_user_settings.md?ref_type=heads) and [Taylor diagrams](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/EXTRA_CHAPTERS/Taylor_user_settings.md?ref_type=heads). A comprehensive collection of reproducible workflows is available in the [examples](https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/EXAMPLE/RUNNERS?ref_type=heads), demonstrating typical evaluation setups and wrapper-based pipelines. Additional technical details, module descriptions, and theoretical background are provided in the [full documentation](https://gitlab.dkrz.de/clm-community/public/evasuite/-/blob/main/DOCS/Documentation_EvaSuite_v1_0.pdf?ref_type=heads). 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

The easiest way to get help, if you cannot find the answer in the documentation in our [docs](https://gitlab.dkrz.de/clm-community/public/evasuite/-/tree/main/DOCS?ref_type=heads), is to open an [issue on GitLab](https://gitlab.dkrz.de/clm-community/public/evasuite/-/issues?sort=created_date&state=opened&first_page_size=100).


## Contributing
If you would like to contribute a new diagnostic or feature, please have a join to the [CLM-Community](https://www.clm-community.eu/) and read CLM-Community contribution guidelines.
