Skip to content

Commit 0053aa0

Browse files
author
BenMGeo
committed
adds details for the recipe
1 parent 3e56331 commit 0053aa0

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

_episodes/first_example_recipe.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,26 +130,47 @@ Please note the following sections:
130130
- documentation: lines 4-20
131131
132132
The documentation consists of the following information:
133-
- description: a one line description of the recipe
133+
- description: a short description of the recipe
134134
- authors: a list of authors (linked to esmvaltool/config-references.yml)
135135
- maintainer: a list of maintainers (linked to esmvaltool/config-references.yml)
136136
- references: a list of references (linked to a bibtexfile in esmvaltool/references with the same name)
137137
- projects: a list of projects (linked to esmvaltool/config-references.yml)
138138
139139
140-
- datasets: lines 22-23
141-
The dataset definition consists of a list of dictionaries with the information on the datasets.
142-
[List of entries?]
140+
- datasets: lines 22-23
143141
142+
The dataset definition consists of a list of python dictionaries with the information on the datasets.
143+
- dataset name (key: dataset)
144+
- project (key: project)
145+
- experiment (key: exp)
146+
- mip (for CMIP data, key: mip)
147+
- ensemble member (key: ensemble)
148+
- time range (e.g. key-value-pair: start_year: 1982, end_year: 1990)
149+
- model grid (for CMIP6 data only, key: grid)
150+
- alias (key: alias; use the alias for e.g. a more human readable name)
144151
145-
- preprocessors: lines 25-28
146-
The definition for different preprocessors or combinations.
147-
[go into detail]
152+
153+
- preprocessors: lines 25-28
154+
155+
The definition for different preprocessors or combinations.
156+
If no preprocessing is needed, the preprocessor can be set to an empty python dictionary (`{}`).
157+
Here, we produce annual means. The preprocessor is called with its name (here: prep_timeseries), later in the diagnostic (line 39).
158+
(See episode #5 LINK for more details.)
148159
149160
150161
- diagnostic section: lines 30-42
162+
151163
The information of which diagnostic script to run with which variables.
152-
[go into detail]
164+
The diagnostics section has some indents that are free to call.
165+
- the first indent (here: diag_timeseries_temperature) is the diagnostic’s name (a string without whitespace), used for setting up the respective directories
166+
- description: a short description of the diagnostic
167+
- variables: a definition of all variables that are used in this diagnostic
168+
- the next indent (here: timeseries_variable) is the variables’ names (a string without whitespace) for the diagnostic to use
169+
- short_name: the variable name as listed in the dataset
170+
- preprocessor: the preprocessor(s) applied to the variable before running the diagnostic
171+
- scripts: a definition of all scripts that are used in this diagnostic
172+
- the next indent (here: timeseries_diag) is the scripts’ names (a string without whitespace) for the script to use
173+
- script: a executable script with a directory relative to the `esmvaltool/diag_scripts/` directory
153174
154175
155176
> What is the short_name of the variable being analysed?
@@ -168,9 +189,8 @@ Please note the following sections:
168189
> ~~~
169190
> esmvaltool -c user-config.yml recipe_example.yml
170191
> ~~~
171-
>
172192
> {: .source}
173-
> What
193+
> What ...
174194
{: .challenge}
175195
176196

0 commit comments

Comments
 (0)