Skip to content

Commit 9e505ff

Browse files
committed
fix indentation and typos
1 parent fade330 commit 9e505ff

File tree

5 files changed

+48
-42
lines changed

5 files changed

+48
-42
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Episodes are [Markdown](https://en.wikipedia.org/wiki/Markdown) files. If you
8383
are making a new episode or contributing to existing ones, please make sure the
8484
content conforms to the [Carpentries lesson formatting][swc-lesson-formatting].
8585

86-
We also, recommend using a linter to check errors in Markdown files. For
86+
We also recommend using a linter to check errors in Markdown files. For
8787
example, a
8888
[markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
8989
can be installed as an extension in [Visual Studio

_episodes/01-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ technical steps, let's talk about what ESMValTool is all about.
4545
ESMValTool takes care of finding, opening, checking, fixing, concatenating, and
4646
preprocessing CMIP data and several other supported datasets.
4747

48-
The central componnent of ESMValTool that we will see in this tutorial is the
48+
The central component of ESMValTool that we will see in this tutorial is the
4949
**recipe**. Any ESMValTool recipe is basically a set of instructions to reproduce
5050
a certain result. The basic structure of a recipe is as follows:
5151

_episodes/02-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The instructions help with the installation of ESMValTool on operating systems
1919
like Linux/MacOSX/Windows.
2020
We use the [Conda](https://conda.io/projects/conda/en/latest/index.html)
2121
package manager to
22-
install the ESMValTool. Other installation methods are also available, they can
22+
install the ESMValTool. Other installation methods are also available; they can
2323
be found in the
2424
[documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html).
2525
We will first install Conda, and then ESMValTool. We end this chapter by testing

_episodes/03-configuration.md

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,12 @@ For example, `write_plots: true` means that diagnostics create plots.
7171

7272
> ## Saving preprocessed data
7373
>
74-
> Later in this tutorial, we will want to look at the contents of the `preproc` folder.
75-
> This folder contains preprocessed data and is removed by default when ESMValTool is run.
76-
> In the configuration file, which settings can be modified to prevent this from happening?
74+
> Later in this tutorial, we will want to look at the contents of the
75+
> `preproc` folder.
76+
> This folder contains preprocessed data and is removed by default when
77+
> ESMValTool is run.
78+
> In the configuration file, which settings can be modified to prevent
79+
> this from happening?
7780
>
7881
>> ## Solution
7982
>>
@@ -89,10 +92,11 @@ For example, `write_plots: true` means that diagnostics create plots.
8992

9093
## Destination directory
9194

92-
The destination directory is the rootpath where ESMValTool will store its output folders containing
93-
e.g. figures, data, logs, etc. With every run, ESMValTool automatically generates
94-
a new output folder determined by recipe name, and date and time using
95-
the format: YYYYMMDD_HHMMSS.
95+
The destination directory is the rootpath where ESMValTool will store its
96+
output folders containing
97+
e.g. figures, data, logs, etc. With every run, ESMValTool automatically
98+
generates a new output folder determined by recipe name, and date and time
99+
using the format: YYYYMMDD_HHMMSS.
96100

97101
> ## Set the destination directory
98102
>
@@ -153,28 +157,29 @@ example configuration file.
153157
>> You need to add the root path of the folder where the data is available
154158
>> to the `config-user.yml` file as:
155159
>>```yaml
156-
>> rootpath:
157-
>> ...
158-
>> CMIP5: ~/esmvaltool_tutorial/data
159-
>> CMIP6: ~/esmvaltool_tutorial/data
160+
>> rootpath:
161+
>> ...
162+
>> CMIP5: ~/esmvaltool_tutorial/data
163+
>> CMIP6: ~/esmvaltool_tutorial/data
160164
>>```
161165
>>
162166
>> - Are you working with on a computer cluster like Jasmin or DKRZ?
163167
>> Site-specific path to the data are already listed at the end of the
164168
>> `config-user.yml` file. You need to uncomment the related lines.
165169
>> For example, on Jasmin:
170+
>>
166171
>>```yaml
167-
>> # Site-specific entries: Jasmin
168-
>> # Uncomment the lines below to locate data on JASMIN
169-
>> rootpath:
170-
>> CMIP6: /badc/cmip6/data/CMIP6
171-
>> CMIP5: /badc/cmip5/data/cmip5/output1
172-
>> # CMIP3: /badc/cmip3_drs/data/cmip3/output
173-
>> # OBS: /group_workspaces/jasmin4/esmeval/obsdata-v2
174-
>> # OBS6: /group_workspaces/jasmin4/esmeval/obsdata-v2
175-
>> # obs4mips: /group_workspaces/jasmin4/esmeval/obsdata-v2
176-
>> # ana4mips: /group_workspaces/jasmin4/esmeval/obsdata-v2
177-
>> # CORDEX: /badc/cordex/data/CORDEX/output
172+
>> # Site-specific entries: Jasmin
173+
>> # Uncomment the lines below to locate data on JASMIN
174+
>> rootpath:
175+
>> CMIP6: /badc/cmip6/data/CMIP6
176+
>> CMIP5: /badc/cmip5/data/cmip5/output1
177+
>> # CMIP3: /badc/cmip3_drs/data/cmip3/output
178+
>> # OBS: /group_workspaces/jasmin4/esmeval/obsdata-v2
179+
>> # OBS6: /group_workspaces/jasmin4/esmeval/obsdata-v2
180+
>> # obs4mips: /group_workspaces/jasmin4/esmeval/obsdata-v2
181+
>> # ana4mips: /group_workspaces/jasmin4/esmeval/obsdata-v2
182+
>> # CORDEX: /badc/cordex/data/CORDEX/output
178183
>>```
179184
>>
180185
>> - For more information about setting the rootpath, see also the ESMValTool
@@ -217,17 +222,17 @@ information about ``drs``, you can visit the ESMValTool documentation on
217222
>> `config-user.yml` file. You need to uncomment the related lines.
218223
>> For example, on Jasmin:
219224
>>```yaml
220-
>> # Site-specific entries: Jasmin
221-
>> # Uncomment the lines below to locate data on JASMIN
222-
>> drs:
223-
>> CMIP6: BADC
224-
>> CMIP5: BADC
225-
>> # CMIP3: BADC
226-
>> # CORDEX: BADC
227-
>> # OBS: BADC
228-
>> # OBS6: BADC
229-
>> # obs4mips: BADC
230-
>> # ana4mips: BADC
225+
>> # Site-specific entries: Jasmin
226+
>> # Uncomment the lines below to locate data on JASMIN
227+
>> drs:
228+
>> CMIP6: BADC
229+
>> CMIP5: BADC
230+
>> # CMIP3: BADC
231+
>> # CORDEX: BADC
232+
>> # OBS: BADC
233+
>> # OBS6: BADC
234+
>> # obs4mips: BADC
235+
>> # ana4mips: BADC
231236
>>```
232237
>>
233238
> {: .solution}
@@ -236,10 +241,10 @@ information about ``drs``, you can visit the ESMValTool documentation on
236241
> ## Explain the default drs (if working on local machine)
237242
>
238243
> 1. In the previous exercise, we set the `drs` of CMIP5 data to `default`.
239-
> Can you explain why?
240-
>
244+
> Can you explain why?
245+
241246
> 2. Have a look at the directory structure of the data.
242-
> There is the folder `Tier1`. What does it mean?
247+
> There is the folder `Tier1`. What does it mean?
243248
>
244249
>> ## Solution
245250
>>
@@ -288,7 +293,8 @@ the tutorial, please set ESMValTool use only 1 cpu:
288293
Then, check the amount of memory you need for that by inspecting the file
289294
``run/resource_usage.txt`` in the output directory. Using the number there you
290295
can increase the number of parallel tasks again to a reasonable number for the
291-
amount of memory available in your system. {: .callout}
296+
amount of memory available in your system.
297+
{: .callout}
292298
293299
> ## Make your own configuration file
294300
>

_episodes/04-recipe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ distinguished in the log messages:
239239
> > Just after 'creating tasks' and before 'executing tasks', we find the
240240
> > following line in the output:
241241
> >
242-
> > ```sh
242+
> > ```
243243
> > INFO [29586] These tasks will be executed: timeseries/tas_global, timeseries/tas_amsterdam, map/tas, map/script1, timeseries/script1
244244
> > ```
245245
> >
@@ -427,7 +427,7 @@ Do you recognize the basic recipe structure that was introduced in episode 1?
427427
> `tas_global`. Both of them operate on the variable `tas` (as indicated by the
428428
> `short_name`), but they apply different preprocessors. For the diagnostic
429429
> `map` the variable group itself is named `tas`, and you'll notice that we do
430-
> not explicitly provide the `short_name`. This is a shorthand build into
430+
> not explicitly provide the `short_name`. This is a shorthand built into
431431
> ESMValTool.
432432
{: .callout}
433433

0 commit comments

Comments
 (0)