You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _episodes/first_example_recipe.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,14 +25,15 @@ This episode describes how ESMValTool recipes work, how to run a recipe and how
25
25
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.
26
26
27
27
- datasets: what datasets you want to use, including
28
-
- the time range and time resolution,
29
-
- the MIP, ensemble member,
28
+
- the time period and temporal resolution,
29
+
- the MIP (Model Intercomparison Project, like atmospheric MIP monthly data: amon),
30
+
- ensemble member,
30
31
- the experiment (i.e. historical, ssp125, etc.),
31
-
- and the grid type (CMIP6 only).
32
+
- and the grid type (necessary for CMIP6 only).
32
33
33
-
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, listing
34
+
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, defining
34
35
- which preprocessor modules to apply,
35
-
- the order to apply them,
36
+
- the order in which they are applied,
36
37
- and the preprocessor arguments.
37
38
38
39
This section can also be optional, if no preprocessing is needed.
@@ -42,17 +43,17 @@ Recipes are the instructions that you give to ESMValTool that tell it what you w
42
43
- the desired diagnostic script to use,
43
44
- and additional diagnostic script options or arguments, if needed.
44
45
45
-
Also include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
46
+
It is possible to also include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
46
47
47
48
- description: a brief description of the recipe, including
48
49
- who wrote the recipe and who maintains it,
49
-
- which project is responsible for it,
50
-
- and which publications, references are linked with the recipe.
50
+
- which project the recipe was written for,
51
+
- and which publications and references are linked with the recipe.
51
52
52
-
Note that the authors, publications and references are to be named in the config-references.yml
53
+
Note that the authors, publications and references need to be included in the `config-references.yml` for the recipe to run successfully.
53
54
54
55
The information you provide in the recipe is not only affecting the processes you are starting, but also the directory names your output will be structured in.
55
-
For additional reeds, please have a look at the recipe format description in the [ESMValTool manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-diagnostics).
56
+
For additional reads, please have a look at the recipe format description in the [ESMValTool manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-diagnostics).
56
57
57
58
## How to run ESMValTool
58
59
@@ -67,7 +68,7 @@ To try your hand with a basic recipe, please work through this episode.
67
68
## Introduction to the example recipe
68
69
The recipe presented here is a simple, basic recipe that takes a single dataset and produces a time series plot.
69
70
70
-
Please download the following recipe into your ESMValTool working area with the name: recipe_example.yml LINK
71
+
Please download the following recipe into your ESMValTool working directory with the name: recipe_example.yml LINK
71
72
72
73
> ## recipe_example.yml
73
74
> ~~~YAML
@@ -117,7 +118,7 @@ Please download the following recipe into your ESMValTool working area with the
117
118
{: .solution}
118
119
119
120
> ## Explore the recipe
120
-
> Use the command and investigate the sample recipe.
121
+
> Use the following command and investigate the sample recipe.
121
122
> ~~~bash
122
123
> vim recipe_example.yml
123
124
> ~~~
@@ -128,10 +129,10 @@ Please note the following sections:
128
129
129
130
The documentation consists of the following information:
130
131
- description: a short description of the recipe
131
-
- authors: a list of authors (linked to esmvaltool/config-references.yml)
132
-
- maintainer: a list of maintainers (linked to esmvaltool/config-references.yml)
133
-
- references: a list of references (linked to a bibtexfile in esmvaltool/references with the same name)
134
-
- projects: a list of projects (linked to esmvaltool/config-references.yml)
132
+
- authors: a list of authors (linked to `esmvaltool/config-references.yml`)
133
+
- maintainer: a list of maintainers (linked to `esmvaltool/config-references.yml`)
134
+
- references: a list of references (linked to a bibtexfile in `esmvaltool/references` with the same name)
135
+
- projects: a list of projects (linked to `esmvaltool/config-references.yml`)
135
136
136
137
137
138
- datasets: lines 22-23
@@ -144,7 +145,7 @@ Please note the following sections:
144
145
- ensemble member (key: ensemble)
145
146
- time range (e.g. key-value-pair: start_year: 1982, end_year: 1990)
146
147
- model grid (for CMIP6 data only, key: grid)
147
-
- alias (key: alias; use the alias for e.g. a more human readable name)
148
+
- alias (key: alias; use the alias for e.g. a more human readable name for the dataset)
0 commit comments