Skip to content

Commit 92f5a1a

Browse files
committed
Fix some linter errors
1 parent f156a26 commit 92f5a1a

File tree

2 files changed

+21
-19
lines changed

2 files changed

+21
-19
lines changed

_episodes/03-configuration.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ keypoints:
2020
## The configuration file
2121

2222
The ``config-user.yml`` configuration file contains all the global level
23-
information needed by ESMValTool to run. This is an [YAML
24-
file](https://yaml.org/spec/1.2/spec.html). An example configuration file can be
25-
found in the ESMValCore repository:
23+
information needed by ESMValTool to run.
24+
This is a [YAML file](https://yaml.org/spec/1.2/spec.html).
25+
An example configuration file can be found in the ESMValCore repository:
2626
[config-user-example.yml](https://github.com/ESMValGroup/ESMValCore/blob/master/esmvalcore/config-user.yml).
2727

2828
You can generate the default configuration file by running:
@@ -184,7 +184,8 @@ rootpath:
184184
default: ~/default_inputpath
185185
CORDEX: ~/default_inputpath
186186
```
187-
Site-specific entries for Jasmin, DKRZ and ETHZ are listed at the end of the example configuration file.
187+
Site-specific entries for Jasmin, DKRZ and ETHZ are listed at the end of the
188+
example configuration file.
188189
189190
In this lesson, we will work with data from
190191
[CMIP5](https://esgf-node.llnl.gov/projects/cmip5/).

_episodes/04-recipe.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ diagnostics and description.
6464

6565
The information you provide in the recipe is not only affecting the processes
6666
you are starting, but also the directory names your output will be structured
67-
in. For additional reads, please have a look at the recipe format description in
68-
the [ESMValTool
69-
manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-diagnostics).
67+
in.
68+
For additional reads, please have a look at the recipe format description in the
69+
[ESMValTool manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-diagnostics).
7070

7171
## How to run ESMValTool
7272

@@ -80,37 +80,34 @@ environment, (see
8080
~~~bash
8181
esmvaltool run /path/to/recipe_example.yml
8282
~~~
83-
{: .source}
8483

8584
If the configuration file is not in the default location
8685
`~/.esmvaltool/config-user.yml`, you can pass its path explicitly:
8786

8887
~~~bash
8988
esmvaltool run --config_file /path/to/config-user.yml /path/to/recipe_example.yml
9089
~~~
91-
{: .source}
9290

9391
Note that the path to the recipe can be either a path to a recipe file or it can
9492
be the name of an installed recipe.
9593
To view the list of installed recipes, run
9694
~~~bash
9795
esmvaltool recipes list
9896
~~~
99-
{: .source}
10097

10198
To try your hand with a basic recipe, please work through this episode.
10299

103100
## Introduction to the example recipe
104101
The recipe presented here is a simple, basic recipe that takes a single dataset
105102
and produces a time series plot.
106103

107-
Please download [recipe_example.yml](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/data/recipe_example.yml)
104+
Please download
105+
[recipe_example.yml](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/data/recipe_example.yml)
108106
into your ESMValTool working directory:
109107

110108
~~~bash
111109
wget https://raw.githubusercontent.com/ESMValGroup/ESMValTool_Tutorial/master/data/recipe_example.yml
112110
~~~
113-
{: .source}
114111

115112
> ## recipe_example.yml
116113
> ```YAML
@@ -174,9 +171,12 @@ Please note the following sections:
174171
175172
- description: a short description of the recipe
176173
- authors: a list of authors (linked to `esmvaltool/config-references.yml`)
177-
- maintainer: a list of maintainers (linked to `esmvaltool/config-references.yml`)
178-
- references: a list of references (linked to a bibtexfile in `esmvaltool/references` with the same name)
179-
- projects: a list of projects (linked to `esmvaltool/config-references.yml`)
174+
- maintainer: a list of maintainers (linked to
175+
`esmvaltool/config-references.yml`)
176+
- references: a list of references (linked to a bibtexfile in
177+
`esmvaltool/references` with the same name)
178+
- projects: a list of projects (linked to
179+
`esmvaltool/config-references.yml`)
180180
181181
182182
- datasets: lines 22-23
@@ -196,11 +196,12 @@ Please note the following sections:
196196
197197
- preprocessors: lines 25-28
198198
199-
The definition for different preprocessors or preprocessor combinations. If no
200-
preprocessing is needed, the preprocessor can be set to an empty python
201-
dictionary (`{}`). Here, we produce annual means. The preprocessor is called
199+
The definition for different preprocessors or preprocessor combinations.
200+
If no preprocessing is needed, the preprocessor can be set to an empty
201+
map (`{}`). Here, we produce annual means. The preprocessor is called
202202
with its name (here: prep_timeseries), later in the diagnostic (line 39).
203-
(See [episode #5]({{ page.root}}{% link _episodes/05-preprocessor.md %}) for more details.)
203+
(See [episode #5]({{ page.root}}{% link _episodes/05-preprocessor.md %})
204+
for more details.)
204205
205206
- diagnostic section: lines 30-42
206207

0 commit comments

Comments
 (0)