Coverage Report

File	Stmts	Miss	Cover	Missing
src/iconeval
init.py	16	0	100%
_config.py	13	0	100%
_dependencies.py	16	0	100%
_job.py	98	0	100%
_logging.py	16	0	100%
_recipe.py	12	0	100%
_session.py	190	0	100%
_simulation_info.py	42	0	100%
_templates.py	224	0	100%
_typing.py	6	0	100%
main.py	159	0	100%
src/iconeval/output_handling
init.py	0	0	100%
_summarize.py	193	0	100%
publish_html.py	118	0	100%
TOTAL	1103	0	100%

---

ICONEval

ICONEval is a command line tool that facilitates the evaluation of ICON model output with ESMValTool by automatically running a set of predefined ESMValTool recipes. For this, ICONEval reads a set of template files (ESMValTool recipes and ESMValTool configuration) and fills these with the information from the ICON simulation(s) that shall be evaluated.

Table of Contents

1. Quick Start
2. Prerequisites
3. Installation
4. Customization
5. Common ICON Output Format
6. FAQs

Quick Start

On Levante, load the module via:

module use -a /shared/bd1179/modulefiles
module load iconeval

The only necessary argument of ICONEval is a valid ICON model output path:

iconeval path/to/ICON_output

This path should point to the directory whose name is identical to the experiment name of the ICON simulation you want to evaluate, e.g., /root/to/my_amip_run for the experiment my_amip_run. In this case, the simulation output files should be named my_amip_run_*_<date>.nc.

Multiple simulations can be evaluated simultaneously by specifying multiple ICON output paths.

ICONEval is highly customizable. An example of more realistic command line call could look like this:

iconeval path/to/ICON_output path/to/other/ICON_output --tags='["atmosphere", "!subdaily"]' --publish_html=True --timerange=20070101/20080101 --frequency=day

Options used here:

• --tags: Instead of running the default set of recipes, this will only run recipe templates marked with certain tags.
• --publish_html: A summary HTML of the evaluation run will be published on a public website (see also additional command line options).
• --timerange: The desired time period that shall be evaluated (see also additional command line options).
• --frequency: The temporal frequency of the ICON data (see also additional command line options).

For more information on this and a list of all options, run:

iconeval -- --help

or have a look at the section on Customization.

Installing ICONEval also provides the command line tool publish_html, which can be used to publish a summary HTML on a public website for arbitrary ESMValTool output. For more information, run:

publish_html -- --help

Example Results

• Fully coupled historical ICON-XPP simulation

Prerequisites

ICONEval needs to run on a machine where the Slurm Workload Manager is available for the submission of jobs.

Installation

On DKRZ's Levante, a pre-installed version of ICONEval is available via a module. Thus, there is no need to install it yourself as a user on this machine.

However, on other machines, or if you would like to develop new features for ICONEval on Levante, an installation from source (development installation) is necessary.

Levante

To load the ICONEval module on Levante, use:

module use -a /shared/bd1179/modulefiles
module load iconeval

Add these lines to your shell configuration file if you use ICONEval regularly. This file describes how the ICONEval module is set up.

Installation from Source (Development Installation)

Installation from source is described here.

Customization

ICONEval is highly customizable. Detailed information on this can be found here.

Common ICON Output Format

To ensure that ICONEval works smoothly, the ICON simulation output should follow these criteria as closely as possible.

FAQs

A set of frequently asked questions can be found here.