Skip to content

Commit 4b099d4

Browse files
committed
Added title to recipe and some other minor edits for better readability
1 parent 1e0a07e commit 4b099d4

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

_episodes/06-preprocessor.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ keypoints:
2222

2323
One of the key strenghts of ESMValTool is in making complex analyses reusable
2424
and reproducible. But that doesn't mean everything in ESMValTool needs to be
25-
complex. Sometimes, the biggest challenge is in making things simpler. You
25+
complex. Sometimes, the biggest challenge is in keeping things simple. You
2626
probably know the 'warming stripes' visualization by Professor Ed Hawkins. On
2727
the site <https://showyourstripes.info> you can find the same visualization for
2828
many regions in the world.
@@ -46,9 +46,9 @@ preprocessing, and then runs our Python script.
4646

4747
> ## Drawing up a plan
4848
>
49-
> Previously, we have seen that ESMValTool executed a number of
50-
> tasks. Write down which tasks we will need to do in this episode. And what do
51-
> each of these tasks do?
49+
> Previously, we saw that running ESMValTool executes a number of
50+
> tasks. Write down what tasks we will need to execute in this episode and what
51+
> each of these tasks does?
5252
>
5353
> > ## Answer
5454
> >
@@ -95,7 +95,8 @@ description.
9595
---
9696
documentation:
9797
description: Reproducing Ed Hawkins' warming stripes visualization
98-
title: This recipe produces warming stripes.
98+
title: Reproducing Ed Hawkins' warming stripes visualization.
99+
99100
```
100101

101102
Notice that `yaml` always requires 2 spaces indentation between the different
@@ -118,9 +119,8 @@ Error validating data /home/user/esmvaltool_tutorial/recipe_barcodes.yml with sc
118119
{: .error}
119120

120121
Here, ESMValTool is telling us that it is missing a required field, namely the
121-
authors. It is good to know that ESMValTool always tries to validate the recipe
122-
in an early stage. This initial check doesn't catch everything though, so we
123-
should always stay alert.
122+
authors. We see that ESMValTool always tries to validate the recipe
123+
at an early stage.
124124

125125
Let's add some additional information to the recipe. Open the recipe file again,
126126
and add an authors section below the description. ESMValTool expects the authors
@@ -140,6 +140,8 @@ below the documentation. The file should now look like:
140140
---
141141
documentation:
142142
description: Reproducing Ed Hawkins' warming stripes visualization
143+
title: Reproducing Ed Hawkins' warming stripes visualization.
144+
143145
authors:
144146
- doe_john
145147
diagnostics:
@@ -354,7 +356,7 @@ for each of the modifications we'll make below.
354356
> > You could have used `extract_point` or `extract_region`. We used
355357
> > `extract_point`. Here's a copy of the [recipe at this
356358
> > point](../files/recipe_warming_stripes_local.yml) and this is the difference
357-
> > with the previous recipe:
359+
> > from the previous recipe:
358360
> >
359361
> > ```diff
360362
> > --- recipe_warming_stripes.yml

0 commit comments

Comments
 (0)