Skip to content

Commit ecf7b59

Browse files
authored
Merge pull request #66 from ESMValGroup/episode_04_issues
Leftover issues for episode 04
2 parents 15d1b36 + 990cb60 commit ecf7b59

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

_episodes/04-recipe.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ exercises: 30
55
questions:
66
- "What is a recipe?"
77
- "How can I do the same preprocessing on many different datasets?"
8-
- "What are the files and directories that are created after running a recipe?"
98
- "What happens when I run a recipe?"
9+
- "What are the files and directories that are created after running a recipe?"
1010
objectives:
1111
- "Run an ESMValTool recipe"
1212
- "Understand the purpose of different settings in the recipe"
@@ -70,9 +70,9 @@ manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overvie
7070

7171
## How to run ESMValTool
7272

73-
Once you’ve set up your conda environment and installed ESMValTool (see episode
74-
#2 LINK) and set up your config-user.yml file to correctly match you local
75-
environment, (see episode #3 LINK), ESMValTool is invoked using a simple
73+
Once you’ve set up your conda environment and installed ESMValTool (see[ episode
74+
#2]({{ page.root}}{% link _episodes/02-installation.md %})) and set up your `config-user.yml` file to correctly match your local
75+
environment, (see [episode #3]({{ page.root}}{% link _episodes/03-configuration.md %})), ESMValTool is invoked using a simple
7676
command:
7777

7878
~~~
@@ -94,7 +94,7 @@ The recipe presented here is a simple, basic recipe that takes a single dataset
9494
and produces a time series plot.
9595

9696
Please download the following recipe into your ESMValTool working directory with
97-
the name: recipe_example.yml LINK
97+
the name: [recipe_example.yml](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/data/recipe_example.yml)
9898

9999
> ## recipe_example.yml
100100
> ```YAML
@@ -152,8 +152,9 @@ the name: recipe_example.yml LINK
152152
153153
Please note the following sections:
154154
155-
- documentation: lines 4-20.
156-
The documentation consists of the following information:
155+
- documentation: lines 4-20
156+
157+
The documentation consists of the following information:
157158
158159
- description: a short description of the recipe
159160
- authors: a list of authors (linked to `esmvaltool/config-references.yml`)
@@ -179,16 +180,16 @@ Please note the following sections:
179180
180181
- preprocessors: lines 25-28
181182
182-
The definition for different preprocessors or combinations. If no
183+
The definition for different preprocessors or preprocessor combinations. If no
183184
preprocessing is needed, the preprocessor can be set to an empty python
184185
dictionary (`{}`). Here, we produce annual means. The preprocessor is called
185186
with its name (here: prep_timeseries), later in the diagnostic (line 39).
186-
(See episode #5 LINK for more details.)
187+
(See [episode #5]({{ page.root}}{% link _episodes/05-preprocessor.md %}) for more details.)
187188
188189
- diagnostic section: lines 30-42
189190
190191
The information of which diagnostic script to run with which variables. The
191-
diagnostics section has some indents that are free to call.
192+
diagnostics section has some indents that are free to be called.
192193
193194
- the first indent (here: diag_timeseries_temperature) is the diagnostic’s
194195
name (a string without whitespace), used for setting up the respective
@@ -229,7 +230,7 @@ Please note the following sections:
229230
{: .solution}
230231
231232
> ## What do you think running this recipe will produce?
232-
> A time series plot of thetaoga with increements of 1 year.
233+
> A time series plot of thetaoga with increments of 1 year.
233234
{: .solution}
234235
235236
> ## Not all parts of the recipe are mandatory
@@ -346,7 +347,7 @@ runtime. This folder should contain four folders:
346347
> ## Inspect the output:
347348
> Now that you have run the esmvaltool command for the first time, please locate
348349
> your output directory. If you’re missing the preproc directory, then your
349-
> config-user.yml file has the value remove_preproc_dir set to true (this is
350+
> `config-user.yml` file has the value remove_preproc_dir set to true (this is
350351
> used to save disk space). Please set this value to false and run the recipe
351352
> again.
352353
>
@@ -663,8 +664,8 @@ The snippets for the edits can be found below:
663664
664665
> ## esmvaltool not found
665666
> Can you run the command “esmvaltool -h”. If no, then it’s possible that the
666-
> conda environment isn’t activated. Please return to the installation section,
667-
> episode #2 LINK.
667+
> conda environment isn’t activated. Please return to the in
668+
> [installation section]({{ page.root }}{% link _episodes/02-installation.md %}).
668669
{: .solution}
669670
670671
> ## The error message is `esmvalcore._recipe_checks.RecipeError: Missing data`

_episodes/05-preprocessor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ file afterwards. These do not need to be explicitly included in recipes.
8888

8989
> ## Exercise: Adding more preprocessor steps
9090
>
91-
> Edit the [example recipe](LINK to episode #4) to first change the variable
91+
> Edit the [example recipe](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/data/recipe_example.yml) to first change the variable
9292
> thetao, then add preprocessors to average over the latitude and longitude
9393
> dimensions and finally average over the depth. Now run the recipe.
9494
>

0 commit comments

Comments
 (0)