Running your first recipe

Overview

Teaching: 15 min
Exercises: 15 min
Compatibility: ESMValTool v2.8.0

Questions

How to run a recipe?

What happens when I run a recipe?

Objectives

Run an existing ESMValTool recipe

Examine the log information

Navigate the output created by ESMValTool

Make small adjustments to an existing recipe

This episode describes how ESMValTool recipes work, how to run a recipe and how to explore the recipe output. By the end of this episode, you should be able to run your first recipe, look at the recipe output, and make small modifications.

Running an existing recipe

The recipe format has briefly been introduced in the Introduction episode. To see all the recipes that are shipped with ESMValTool, type

esmvaltool recipes list

We will start by running examples/recipe_python.yml

esmvaltool run examples/recipe_python.yml

or if you have the user configuration file in your current directory then

esmvaltool run --config_file ./config-user.yml examples/recipe_python.yml

If everything is okay, you should see that ESMValTool is printing a lot of output to the command line. The final message should be “Run was successful”. The exact output varies depending on your machine, but it should look something like the example log output on terminal below.

Example output

2023-05-01 20:59:33,345 UTC [18776] INFO    
______________________________________________________________________
         _____ ____  __  ____     __    _ _____           _
        | ____/ ___||  \/  \ \   / /_ _| |_   _|__   ___ | |
        |  _| \___ \| |\/| |\ \ / / _` | | | |/ _ \ / _ \| |
        | |___ ___) | |  | | \ V / (_| | | | | (_) | (_) | |
        |_____|____/|_|  |_|  \_/ \__,_|_| |_|\___/ \___/|_|
______________________________________________________________________


ESMValTool - Earth System Model Evaluation Tool.

http://www.esmvaltool.org

CORE DEVELOPMENT TEAM AND CONTACTS:
 Birgit Hassler (Co-PI; DLR, Germany - birgit.hassler@dlr.de)
 Alistair Sellar (Co-PI; Met Office, UK - alistair.sellar@metoffice.gov.uk)
 Bouwe Andela (Netherlands eScience Center, The Netherlands - b.andela@esciencecenter.nl)
 Lee de Mora (PML, UK - ledm@pml.ac.uk)
 Niels Drost (Netherlands eScience Center, The Netherlands - n.drost@esciencecenter.nl)
 Veronika Eyring (DLR, Germany - veronika.eyring@dlr.de)
 Bettina Gier (UBremen, Germany - gier@uni-bremen.de)
 Remi Kazeroni (DLR, Germany - remi.kazeroni@dlr.de)
 Nikolay Koldunov (AWI, Germany - nikolay.koldunov@awi.de)
 Axel Lauer (DLR, Germany - axel.lauer@dlr.de)
 Saskia Loosveldt-Tomas (BSC, Spain - saskia.loosveldt@bsc.es)
 Ruth Lorenz (ETH Zurich, Switzerland - ruth.lorenz@env.ethz.ch)
 Benjamin Mueller (LMU, Germany - b.mueller@iggf.geo.uni-muenchen.de)
 Valeriu Predoi (URead, UK - valeriu.predoi@ncas.ac.uk)
 Mattia Righi (DLR, Germany - mattia.righi@dlr.de)
 Manuel Schlund (DLR, Germany - manuel.schlund@dlr.de)
 Breixo Solino Fernandez (DLR, Germany - breixo.solinofernandez@dlr.de)
 Javier Vegas-Regidor (BSC, Spain - javier.vegas@bsc.es)
 Klaus Zimmermann (SMHI, Sweden - klaus.zimmermann@smhi.se)

For further help, please read the documentation at
http://docs.esmvaltool.org. Have fun!

2023-05-01 20:59:33,345 UTC [18776] INFO    Package versions
2023-05-01 20:59:33,345 UTC [18776] INFO    ----------------
2023-05-01 20:59:33,345 UTC [18776] INFO    ESMValCore: 2.8.0
2023-05-01 20:59:33,346 UTC [18776] INFO    ESMValTool: 2.9.0.dev4+g6948d5512
2023-05-01 20:59:33,346 UTC [18776] INFO    ----------------
2023-05-01 20:59:33,346 UTC [18776] INFO    Using config file /home/users/username/esmvaltool_tutorial/config-user.yml
2023-05-01 20:59:33,346 UTC [18776] INFO    Writing program log files to:
/home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/main_log.txt
/home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/main_log_debug.txt
2023-05-01 20:59:35,209 UTC [18776] INFO    Starting the Earth System Model Evaluation Tool at time: 2023-05-01 20:59:35 UTC
2023-05-01 20:59:35,210 UTC [18776] INFO    ----------------------------------------------------------------------
2023-05-01 20:59:35,210 UTC [18776] INFO    RECIPE   = /apps/jasmin/community/esmvaltool/ESMValTool_2.8.0/esmvaltool/recipes/examples/recipe_python.yml
2023-05-01 20:59:35,210 UTC [18776] INFO    RUNDIR     = /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run
2023-05-01 20:59:35,211 UTC [18776] INFO    WORKDIR    = /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/work
2023-05-01 20:59:35,211 UTC [18776] INFO    PREPROCDIR = /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/preproc
2023-05-01 20:59:35,211 UTC [18776] INFO    PLOTDIR    = /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/plots
2023-05-01 20:59:35,211 UTC [18776] INFO    ----------------------------------------------------------------------
2023-05-01 20:59:35,211 UTC [18776] INFO    Running tasks using at most 8 processes
2023-05-01 20:59:35,211 UTC [18776] INFO    If your system hangs during execution, it may not have enough memory for keeping this number of tasks in memory.
2023-05-01 20:59:35,211 UTC [18776] INFO    If you experience memory problems, try reducing 'max_parallel_tasks' in your user configuration file.
2023-05-01 20:59:35,485 UTC [18776] INFO    For Dataset: tas, Amon, CMIP6, BCC-ESM1, historical, r1i1p1f1, gn, supplementaries: areacella, *, *, *, *: ignoring supplementary variable 'areacella', unable to expand wildcards 'mip', 'exp', 'ensemble', 'activity', 'institute'.
2023-05-01 20:59:35,542 UTC [18776] INFO    Creating tasks from recipe
2023-05-01 20:59:35,542 UTC [18776] INFO    Creating tasks for diagnostic map
2023-05-01 20:59:35,542 UTC [18776] INFO    Creating diagnostic task map/script1
2023-05-01 20:59:35,544 UTC [18776] INFO    Creating preprocessor task map/tas
2023-05-01 20:59:35,544 UTC [18776] INFO    Creating preprocessor 'to_degrees_c' task for variable 'tas'
2023-05-01 20:59:35,565 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP6, BCC-ESM1, CMIP, historical, r1i1p1f1, gn, v20181214
2023-05-01 20:59:35,571 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP5, bcc-csm1-1, historical, r1i1p1, v1
2023-05-01 20:59:35,573 UTC [18776] INFO    PreprocessingTask map/tas created.
2023-05-01 20:59:35,574 UTC [18776] INFO    Creating tasks for diagnostic timeseries
2023-05-01 20:59:35,574 UTC [18776] INFO    Creating diagnostic task timeseries/script1
2023-05-01 20:59:35,574 UTC [18776] INFO    Creating preprocessor task timeseries/tas_amsterdam
2023-05-01 20:59:35,574 UTC [18776] INFO    Creating preprocessor 'annual_mean_amsterdam' task for variable 'tas_amsterdam'
2023-05-01 20:59:35,583 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP6, BCC-ESM1, CMIP, historical, r1i1p1f1, gn, v20181214
2023-05-01 20:59:35,586 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP5, bcc-csm1-1, historical, r1i1p1, v1
2023-05-01 20:59:35,588 UTC [18776] INFO    PreprocessingTask timeseries/tas_amsterdam created.
2023-05-01 20:59:35,589 UTC [18776] INFO    Creating preprocessor task timeseries/tas_global
2023-05-01 20:59:35,589 UTC [18776] INFO    Creating preprocessor 'annual_mean_global' task for variable 'tas_global'
2023-05-01 20:59:35,589 UTC [18776] WARNING Preprocessor function area_statistics works best when at least one supplementary variable of ['areacella', 'areacello'] is defined in the recipe for Dataset:
{'diagnostic': 'timeseries',
'variable_group': 'tas_global',
'dataset': 'BCC-ESM1',
'project': 'CMIP6',
'mip': 'Amon',
'short_name': 'tas',
'activity': 'CMIP',
'alias': 'CMIP6',
'caption': 'Annual global mean {long_name} according to {dataset}.',
'ensemble': 'r1i1p1f1',
'exp': 'historical',
'frequency': 'mon',
'grid': 'gn',
'institute': ['BCC'],
'long_name': 'Near-Surface Air Temperature',
'modeling_realm': ['atmos'],
'original_short_name': 'tas',
'preprocessor': 'annual_mean_global',
'recipe_dataset_index': 0,
'standard_name': 'air_temperature',
'timerange': '1850/2000',
'units': 'K'}
session: 'recipe_python_20230501_205933'.
2023-05-01 20:59:35,598 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP6, BCC-ESM1, CMIP, historical, r1i1p1f1, gn, v20181214
2023-05-01 20:59:35,603 UTC [18776] INFO    Found input files for Dataset: tas, Amon, CMIP5, bcc-csm1-1, historical, r1i1p1, v1, supplementaries: areacella, fx, 1pctCO2, r0i0p0
2023-05-01 20:59:35,604 UTC [18776] INFO    PreprocessingTask timeseries/tas_global created.
2023-05-01 20:59:35,605 UTC [18776] INFO    These tasks will be executed: map/tas, timeseries/tas_global, timeseries/script1, map/script1, timeseries/tas_amsterdam
2023-05-01 20:59:35,623 UTC [18776] INFO    Wrote recipe with version numbers and wildcards to:
file:///home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/recipe_python_filled.yml
2023-05-01 20:59:35,623 UTC [18776] INFO    Running 5 tasks using 5 processes
2023-05-01 20:59:35,682 UTC [18794] INFO    Starting task map/tas in process [18794]
2023-05-01 20:59:35,682 UTC [18795] INFO    Starting task timeseries/tas_amsterdam in process [18795]
2023-05-01 20:59:35,684 UTC [18796] INFO    Starting task timeseries/tas_global in process [18796]
2023-05-01 20:59:35,772 UTC [18776] INFO    Progress: 3 tasks running, 2 tasks waiting for ancestors, 0/5 done
2023-05-01 20:59:36,762 UTC [18795] INFO    Extracting data for Amsterdam, Noord-Holland, Nederland (52.3730796 °N, 4.8924534 °E)
2023-05-01 20:59:37,685 UTC [18794] INFO    Successfully completed task map/tas (priority 1) in 0:00:02.002836
2023-05-01 20:59:37,880 UTC [18776] INFO    Progress: 2 tasks running, 2 tasks waiting for ancestors, 1/5 done
2023-05-01 20:59:37,892 UTC [18797] INFO    Starting task map/script1 in process [18797]
2023-05-01 20:59:37,903 UTC [18797] INFO    Running command ['/apps/jasmin/community/esmvaltool/miniconda3_py310_23.1.0/envs/esmvaltool/bin/python', '/apps/jasmin/community/esmvaltool/ESMValTool_2.8.0/esmvaltool/diag_scripts/examples/diagnostic.py', '/home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/map/script1/settings.yml']
2023-05-01 20:59:37,904 UTC [18797] INFO    Writing output to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/work/map/script1
2023-05-01 20:59:37,904 UTC [18797] INFO    Writing plots to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/plots/map/script1
2023-05-01 20:59:37,904 UTC [18797] INFO    Writing log to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/map/script1/log.txt
2023-05-01 20:59:37,904 UTC [18797] INFO    To re-run this diagnostic script, run:
cd /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/map/script1; MPLBACKEND="Agg" /apps/jasmin/community/esmvaltool/miniconda3_py310_23.1.0/envs/esmvaltool/bin/python /apps/jasmin/community/esmvaltool/ESMValTool_2.8.0/esmvaltool/diag_scripts/examples/diagnostic.py /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/map/script1/settings.yml
2023-05-01 20:59:37,980 UTC [18776] INFO    Progress: 3 tasks running, 1 tasks waiting for ancestors, 1/5 done
2023-05-01 20:59:38,992 UTC [18795] INFO    Extracting data for Amsterdam, Noord-Holland, Nederland (52.3730796 °N, 4.8924534 °E)
2023-05-01 20:59:40,791 UTC [18795] INFO    Generated PreprocessorFile: /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/preproc/timeseries/tas_amsterdam/MultiModelMean_historical_Amon_tas_1850-2000.nc
2023-05-01 20:59:41,059 UTC [18795] INFO    Successfully completed task timeseries/tas_amsterdam (priority 3) in 0:00:05.375697
2023-05-01 20:59:41,189 UTC [18776] INFO    Progress: 2 tasks running, 1 tasks waiting for ancestors, 2/5 done
2023-05-01 20:59:41,417 UTC [18796] INFO    Successfully completed task timeseries/tas_global (priority 4) in 0:00:05.732484
2023-05-01 20:59:41,590 UTC [18776] INFO    Progress: 1 tasks running, 1 tasks waiting for ancestors, 3/5 done
2023-05-01 20:59:41,602 UTC [18798] INFO    Starting task timeseries/script1 in process [18798]
2023-05-01 20:59:41,611 UTC [18798] INFO    Running command ['/apps/jasmin/community/esmvaltool/miniconda3_py310_23.1.0/envs/esmvaltool/bin/python', '/apps/jasmin/community/esmvaltool/ESMValTool_2.8.0/esmvaltool/diag_scripts/examples/diagnostic.py', '/home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/timeseries/script1/settings.yml']
2023-05-01 20:59:41,612 UTC [18798] INFO    Writing output to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/work/timeseries/script1
2023-05-01 20:59:41,612 UTC [18798] INFO    Writing plots to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/plots/timeseries/script1
2023-05-01 20:59:41,612 UTC [18798] INFO    Writing log to /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/timeseries/script1/log.txt
2023-05-01 20:59:41,612 UTC [18798] INFO    To re-run this diagnostic script, run:
cd /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/timeseries/script1; MPLBACKEND="Agg" /apps/jasmin/community/esmvaltool/miniconda3_py310_23.1.0/envs/esmvaltool/bin/python /apps/jasmin/community/esmvaltool/ESMValTool_2.8.0/esmvaltool/diag_scripts/examples/diagnostic.py /home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/timeseries/script1/settings.yml
2023-05-01 20:59:41,691 UTC [18776] INFO    Progress: 2 tasks running, 0 tasks waiting for ancestors, 3/5 done
2023-05-01 20:59:46,069 UTC [18797] INFO    Maximum memory used (estimate): 0.3 GB
2023-05-01 20:59:46,072 UTC [18797] INFO    Sampled every second. It may be inaccurate if short but high spikes in memory consumption occur.
2023-05-01 20:59:47,192 UTC [18797] INFO    Successfully completed task map/script1 (priority 0) in 0:00:09.298761
2023-05-01 20:59:47,306 UTC [18776] INFO    Progress: 1 tasks running, 0 tasks waiting for ancestors, 4/5 done
2023-05-01 20:59:49,777 UTC [18798] INFO    Maximum memory used (estimate): 0.3 GB
2023-05-01 20:59:49,780 UTC [18798] INFO    Sampled every second. It may be inaccurate if short but high spikes in memory consumption occur.
2023-05-01 20:59:50,866 UTC [18798] INFO    Successfully completed task timeseries/script1 (priority 2) in 0:00:09.263219
2023-05-01 20:59:50,914 UTC [18776] INFO    Progress: 0 tasks running, 0 tasks waiting for ancestors, 5/5 done
2023-05-01 20:59:50,914 UTC [18776] INFO    Successfully completed all tasks.
2023-05-01 20:59:50,959 UTC [18776] INFO    Wrote recipe with version numbers and wildcards to:
file:///home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/run/recipe_python_filled.yml
2023-05-01 20:59:51,233 UTC [18776] INFO    Wrote recipe output to:
file:///home/users/username/esmvaltool_tutorial/esmvaltool_output/recipe_python_20230501_205933/index.html
2023-05-01 20:59:51,233 UTC [18776] INFO    Ending the Earth System Model Evaluation Tool at time: 2023-05-01 20:59:51 UTC
2023-05-01 20:59:51,233 UTC [18776] INFO    Time for running the recipe was: 0:00:16.023887
2023-05-01 20:59:51,787 UTC [18776] INFO    Maximum memory used (estimate): 1.7 GB
2023-05-01 20:59:51,788 UTC [18776] INFO    Sampled every second. It may be inaccurate if short but high spikes in memory consumption occur.
2023-05-01 20:59:51,790 UTC [18776] INFO    Removing `preproc` directory containing preprocessed data
2023-05-01 20:59:51,790 UTC [18776] INFO    If this data is further needed, then set `remove_preproc_dir` to `false` in your user configuration file
2023-05-01 20:59:51,827 UTC [18776] INFO    Run was successful

Pro tip: ESMValTool search paths

You might wonder how ESMValTool was able find the recipe file, even though it’s not in your working directory. All the recipe paths printed from esmvaltool recipes list are relative to ESMValTool’s installation location. This is where ESMValTool will look if it cannot find the file by following the path from your working directory.

Investigating the log messages

Let’s dissect what’s happening here.

Output files and directories

After the banner and general information, the output starts with some important locations.

Did ESMValTool use the right config file?

What is the path to the example recipe?

What is the main output folder generated by ESMValTool?

Can you guess what the different output directories are for?

ESMValTool creates two log files. What is the difference?

Answers

The config file should be the one we edited in the previous episode, something like /home/<username>/.esmvaltool/config-user.yml or ~/esmvaltool_tutorial/config-user.yml.

ESMValTool found the recipe in its installation directory, something like /home/users/username/mambaforge/envs/esmvaltool/bin/esmvaltool/recipes/examples/ or if you are using a pre-installed module on a server, something like /apps/jasmin/community/esmvaltool/ESMValTool_<version> /esmvaltool/recipes/examples/recipe_python.yml, where <version> is the latest release.

ESMValTool creates a time-stamped output directory for every run. In this case, it should be something like recipe_python_YYYYMMDD_HHMMSS. This folder is made inside the output directory specified in the previous episode: ~/esmvaltool_tutorial/esmvaltool_output.

There should be four output folders:

plots/: this is where output figures are stored.

preproc/: this is where pre-processed data are stored.

run/: this is where esmvaltool stores general information about the run, such as log messages and a copy of the recipe file.

work/: this is where output files (not figures) are stored.

The log files are:

main_log.txt is a copy of the command-line output

main_log_debug.txt contains more detailed information that may be useful for debugging.

Debugging: No ‘preproc’ directory?

If you’re missing the preproc directory, then your config-user.yml file has the value remove_preproc_dir set to true (this is used to save disk space). Please set this value to false and run the recipe again.

After the output locations, there are two main sections that can be distinguished in the log messages:

Creating tasks
Executing tasks

Analyse the tasks

List all the tasks that ESMValTool is executing for this recipe. Can you guess what this recipe does?
Answer

Just after all the ‘creating tasks’ and before ‘executing tasks’, we find the following line in the output:
[18776] INFO    These tasks will be executed: map/tas, timeseries/tas_global, 
timeseries/script1, map/script1, timeseries/tas_amsterdam
So there are three tasks related to timeseries: global temperature, Amsterdam temperature, and a script (tas: near-surface air temperature). And then there are two tasks related to a map: something with temperature, and again a script.

Examining the recipe file

To get more insight into what is happening, we will have a look at the recipe file itself. Use the following command to copy the recipe to your working directory

esmvaltool recipes get examples/recipe_python.yml

Now you should see the recipe file in your working directory (type ls to verify). Use the nano editor to open this file:

nano recipe_python.yml

For reference, you can also view the recipe by unfolding the box below.

recipe_python.yml

# ESMValTool
# recipe_python.yml
#
# See https://docs.esmvaltool.org/en/latest/recipes/recipe_examples.html
# for a description of this recipe.
#
# See https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html
# for a description of the recipe format.
---
documentation:
 description: |
   Example recipe that plots a map and timeseries of temperature.

 title: Recipe that runs an example diagnostic written in Python.

 authors:
   - andela_bouwe
   - righi_mattia

 maintainer:
   - schlund_manuel

 references:
   - acknow_project

 projects:
   - esmval
   - c3s-magic

datasets:
 - {dataset: BCC-ESM1, project: CMIP6, exp: historical, ensemble: r1i1p1f1, grid: gn}
 - {dataset: bcc-csm1-1, project: CMIP5, exp: historical, ensemble: r1i1p1}

preprocessors:
 # See https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/preprocessor.html
 # for a description of the preprocessor functions.

 to_degrees_c:
   convert_units:
     units: degrees_C

 annual_mean_amsterdam:
   extract_location:
     location: Amsterdam
     scheme: linear
   annual_statistics:
     operator: mean
   multi_model_statistics:
     statistics:
       - mean
     span: overlap
   convert_units:
     units: degrees_C

 annual_mean_global:
   area_statistics:
     operator: mean
   annual_statistics:
     operator: mean
   convert_units:
     units: degrees_C

diagnostics:

 map:
   description: Global map of temperature in January 2000.
   themes:
     - phys
   realms:
     - atmos
   variables:
     tas:
       mip: Amon
       preprocessor: to_degrees_c
       timerange: 2000/P1M
       caption: |
         Global map of {long_name} in January 2000 according to {dataset}.
   scripts:
     script1:
       script: examples/diagnostic.py
       quickplot:
         plot_type: pcolormesh
         cmap: Reds

 timeseries:
   description: Annual mean temperature in Amsterdam and global mean since 1850.
   themes:
     - phys
   realms:
     - atmos
   variables:
     tas_amsterdam:
       short_name: tas
       mip: Amon
       preprocessor: annual_mean_amsterdam
       timerange: 1850/2000
       caption: Annual mean {long_name} in Amsterdam according to {dataset}.
     tas_global:
       short_name: tas
       mip: Amon
       preprocessor: annual_mean_global
       timerange: 1850/2000
       caption: Annual global mean {long_name} according to {dataset}.
   scripts:
     script1:
       script: examples/diagnostic.py
       quickplot:
         plot_type: plot

Do you recognize the basic recipe structure that was introduced in episode 1?

Documentation with relevant (citation) information
Datasets that should be analysed
Preprocessors groups of common preprocessing steps
Diagnostics scripts performing more specific evaluation steps

Analyse the recipe

Try to answer the following questions:

Who wrote this recipe?

Who should be approached if there is a problem with this recipe?

How many datasets are analyzed?

What does the preprocessor called annual_mean_global do?

Which script is applied for the diagnostic called map?

Can you link specific lines in the recipe to the tasks that we saw before?

How is the location of the city specified?

How is the temporal range of the data specified?

Answers

The example recipe is written by Bouwe Andela and Mattia Righi.

Manuel Schlund is listed as the maintainer of this recipe.

Two datasets are analysed:

CMIP6 data from the model BCC-ESM1

CMIP5 data from the model bcc-csm1-1

The preprocessor annual_mean_global computes an area mean as well as annual means

The diagnostic called map executes a script referred to as script1. This is a python script named examples/diagnostic.py

There are two diagnostics: map and timeseries. Under the diagnostic map we find two tasks:

a preprocessor task called tas, applying the preprocessor called to_degrees_c to the variable tas.

a diagnostic task called script1, applying the script examples/diagnostic.py to the preprocessed data (map/tas).

Under the diagnostic timeseries we find three tasks:

a preprocessor task called tas_amsterdam, applying the preprocessor called annual_mean_amsterdam to the variable tas.

a preprocessor task called tas_global, applying the preprocessor called annual_mean_global to the variable tas.

a diagnostic task called script1, applying the script examples/diagnostic.py to the preprocessed data (timeseries/tas_global and timeseries/tas_amsterdam).

The extract_location preprocessor is used to get data for a specific location here. ESMValTool interpolates to the location based on the chosen scheme. Can you tell the scheme used here? For more ways to extract areas, see the Area operations page.

The timerange tag is used to extract data from a specific time period here. The start time is 01/01/2000 and the span of time to calculate means is 1 Month given by P1M. For more options on how to specify time ranges, see the timerange documentation.

Pro tip: short names and variable groups

The preprocessor tasks in ESMValTool are called ‘variable groups’. For the diagnostic timeseries, we have two variable groups: tas_amsterdam and tas_global. Both of them operate on the variable tas (as indicated by the short_name), but they apply different preprocessors. For the diagnostic map the variable group itself is named tas, and you’ll notice that we do not explicitly provide the short_name. This is a shorthand built into ESMValTool.

Output files

Have another look at the output directory created by the ESMValTool run.

Which files/folders are created by each task?

Answer

map/tas: creates /preproc/map/tas, which contains preprocessed data for each of the input datasets, a file called metadata.yml describing the contents of these datasets and provenance information in the form of .xml files.

timeseries/tas_global: creates /preproc/timeseries/tas_global, which contains preprocessed data for each of the input datasets, a metadata.yml file and provenance information in the form of .xml files.

timeseries/tas_amsterdam: creates /preproc/timeseries/tas_amsterdam, which contains preprocessed data for each of the input datasets, plus a combined MultiModelMean, a metadata.yml file and provenance files.

map/script1: creates /run/map/script1 with general information and a log of the diagnostic script run. It also creates /plots/map/script1 and /work/map/script1, which contain output figures and output datasets, respectively. For each output file, there is also corresponding provenance information in the form of .xml, .bibtex and .txt files.

timeseries/script1: creates /run/timeseries/script1 with general information and a log of the diagnostic script run. It also creates /plots/timeseries/script1 and /work/timeseries/script1, which contain output figures and output datasets, respectively. For each output file, there is also corresponding provenance information in the form of .xml, .bibtex and .txt files.

Pro tip: diagnostic logs

When you run ESMValTool, any log messages from the diagnostic script are not printed on the terminal. But they are written to the log.txt files in the folder /run/<diag_name>/log.txt.

ESMValTool does print a command that can be used to re-run a diagnostic script. When you use this the output will be printed to the command line.

Modifying the example recipe

Let’s make a small modification to the example recipe. Notice that now that you have copied and edited the recipe, you can use

esmvaltool run recipe_python.yml

to refer to your local file rather than the default version shipped with ESMValTool.

Change your location

Modify and run the recipe to analyse the temperature for your own location.
Solution

In principle, you only have to modify the location in the preprocessor called annual_mean_amsterdam. However, it is good practice to also replace all instances of amsterdam with the correct name of your location. Otherwise the log messages and output will be confusing. You are free to modify the names of preprocessors or diagnostics.

In the diff file below you will see the changes we have made to the file. The top 2 lines are the filenames and the lines like @@ -39,9 +39,9 @@ represent the line numbers in the original and modified file, respectively. For more info on this format, see here.
--- recipe_python.yml	
+++ recipe_python_london.yml	
@@ -39,9 +39,9 @@
    convert_units:
      units: degrees_C

-  annual_mean_amsterdam:
+  annual_mean_london:
    extract_location:
-      location: Amsterdam
+      location: London
      scheme: linear
    annual_statistics:
      operator: mean
@@ -83,7 +83,7 @@
          cmap: Reds

  timeseries:
-    description: Annual mean temperature in Amsterdam and global mean since 1850.
+    description: Annual mean temperature in London and global mean since 1850.
    themes:
      - phys
    realms:
@@ -92,9 +92,9 @@
      tas_amsterdam:
        short_name: tas
        mip: Amon
-        preprocessor: annual_mean_amsterdam
+        preprocessor: annual_mean_london
        timerange: 1850/2000
-        caption: Annual mean {long_name} in Amsterdam according to {dataset}.
+        caption: Annual mean {long_name} in London according to {dataset}.
      tas_global:
        short_name: tas
        mip: Amon

Key Points

ESMValTool recipes work ‘out of the box’ (if input data is available)

There are strong links between the recipe, log file, and output folders

Recipes can easily be modified to re-use existing code for your own use case

previous episode

ESMValTool Tutorial

next episode

Running your first recipe

Overview

Running an existing recipe

Example output

Pro tip: ESMValTool search paths

Investigating the log messages

Output files and directories

Answers

Debugging: No ‘preproc’ directory?

Analyse the tasks

Answer

Examining the recipe file

recipe_python.yml

Analyse the recipe

Answers

Pro tip: short names and variable groups

Output files

Answer

Pro tip: diagnostic logs

Modifying the example recipe

Change your location

Solution

Key Points

previous episode

next episode