Skip to content

Commit 5719f1d

Browse files
author
Benjamin Müller
authored
Update first_example_recipe.md
corrects indents
1 parent 5695cf3 commit 5719f1d

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

_episodes/first_example_recipe.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -27,31 +27,31 @@ This episode describes how ESMValTool recipes work, how to run a recipe and how
2727
Recipes are the instructions that you give to ESMValTool that tell it what you want to do. This includes four main sections: datasets, preprocessors, diagnostics and description.
2828

2929
- datasets: what datasets you want to use, including
30-
- the time range and time resolution,
31-
- the MIP, ensemble member,
32-
- the experiment (i.e. historical, ssp125 etc...),
33-
- and the grid type (CMIP6 only).
30+
- the time range and time resolution,
31+
- the MIP, ensemble member,
32+
- the experiment (i.e. historical, ssp125 etc...),
33+
- and the grid type (CMIP6 only).
3434

3535
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, listing
36-
- which preprocessor modules to apply,
37-
- the order to apply them,
38-
- and the preprocessor arguments.
36+
- which preprocessor modules to apply,
37+
- the order to apply them,
38+
- and the preprocessor arguments.
3939

40-
This section can also be optional, if no preprocessing is needed.
40+
This section can also be optional, if no preprocessing is needed.
4141

4242
- diagnostics: all the information about the diagnostic, including
43-
- list of variables to evaluate (with their respective configurations),
44-
- the desired diagnostic script to use,
45-
- and additional diagnostic script options or arguments, if needed.
43+
- list of variables to evaluate (with their respective configurations),
44+
- the desired diagnostic script to use,
45+
- and additional diagnostic script options or arguments, if needed.
4646

47-
Also Include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
47+
Also Include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
4848

4949
- description: a brief description of the recipe, including
50-
- who wrote the recipe and who maintains it,
51-
- which project is responsible for it,
52-
- and which publications, references are linked with the recipe.
50+
- who wrote the recipe and who maintains it,
51+
- which project is responsible for it,
52+
- and which publications, references are linked with the recipe.
5353

54-
Note that the authors, publications and references are to be named in the config-references.yml
54+
Note that the authors, publications and references are to be named in the config-references.yml
5555

5656
This information ...
5757

@@ -138,25 +138,25 @@ Please note the following sections:
138138
- projects: a list of projects (linked to esmvaltool/config-references.yml)
139139
140140
141-
- datasets: lines 22-23
141+
- datasets: lines 22-23
142142
143-
The dataset definition consists of a list of python dictionaries with the information on the datasets.
144-
- dataset name (key: dataset)
145-
- project (key: project)
146-
- experiment (key: exp)
147-
- mip (for CMIP data, key: mip)
148-
- ensemble member (key: ensemble)
149-
- time range (e.g. key-value-pair: start_year: 1982, end_year: 1990)
150-
- model grid (for CMIP6 data only, key: grid)
151-
- alias (key: alias; use the alias for e.g. a more human readable name)
143+
The dataset definition consists of a list of python dictionaries with the information on the datasets.
144+
- dataset name (key: dataset)
145+
- project (key: project)
146+
- experiment (key: exp)
147+
- mip (for CMIP data, key: mip)
148+
- ensemble member (key: ensemble)
149+
- time range (e.g. key-value-pair: start_year: 1982, end_year: 1990)
150+
- model grid (for CMIP6 data only, key: grid)
151+
- alias (key: alias; use the alias for e.g. a more human readable name)
152152
153153
154-
- preprocessors: lines 25-28
154+
- preprocessors: lines 25-28
155155
156-
The definition for different preprocessors or combinations.
157-
If no preprocessing is needed, the preprocessor can be set to an empty python dictionary (`{}`).
158-
Here, we produce annual means. The preprocessor is called with its name (here: prep_timeseries), later in the diagnostic (line 39).
159-
(See episode #5 LINK for more details.)
156+
The definition for different preprocessors or combinations.
157+
If no preprocessing is needed, the preprocessor can be set to an empty python dictionary (`{}`).
158+
Here, we produce annual means. The preprocessor is called with its name (here: prep_timeseries), later in the diagnostic (line 39).
159+
(See episode #5 LINK for more details.)
160160
161161
162162
- diagnostic section: lines 30-42

0 commit comments

Comments
 (0)