Skip to content

Commit 75fc7f0

Browse files
committed
Merge branch 'main' into update_episode06_for_v2.9
2 parents e4b88f3 + ce536fd commit 75fc7f0

13 files changed

+523
-377
lines changed

_episodes/00-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Introduction"
33
teaching: 5
44
exercises: 10
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66

77
questions:
88
- What is ESMValTool?

_episodes/01-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Quickstart guide"
33
teaching: 2
44
exercises: 8
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66

77
questions:
88

_episodes/02-installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Installation"
33
teaching: 10
44
exercises: 10
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66
questions:
77
- "What are the prerequisites for installing ESMValTool?"
88
- "How do I confirm that the installation was successful?"
@@ -229,8 +229,8 @@ to display the command line help.
229229
> > {: .bash}
230230
> > The version of ESMValTool installed should be displayed on the screen as:
231231
> > ~~~
232-
> > ESMValCore: 2.8.0
233-
> > ESMValTool: 2.8.0
232+
> > ESMValCore: 2.10.0
233+
> > ESMValTool: 2.10.0
234234
> > ~~~
235235
> > {: .output}
236236
> Note that on HPC servers such as JASMIN, sometimes a more recent development

_episodes/03-configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Configuration"
33
teaching: 10
44
exercises: 10
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66

77
questions:
88
- What is the user configuration file and how should I use it?
@@ -60,6 +60,8 @@ and then modify it if needed:
6060
nano ~/.esmvaltool/config-user.yml
6161
~~~
6262

63+
Any other editor can be used, e.g.vim.
64+
6365
This file contains the information for:
6466

6567
- Output settings

_episodes/04-recipe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Running your first recipe"
33
teaching: 15
44
exercises: 15
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66

77
questions:
88
- "How to run a recipe?"
@@ -49,7 +49,7 @@ esmvaltool run --config_file ./config-user.yml examples/recipe_python.yml
4949
If everything is okay, you should see that ESMValTool is printing a lot of
5050
output to the command line. The final message should be "Run was successful".
5151
The exact output varies depending on your machine, but it should look something
52-
like the example output below.
52+
like the example log output on terminal below.
5353

5454
{% include example_output.txt %}
5555

@@ -132,7 +132,7 @@ distinguished in the log messages:
132132
> > following line in the output:
133133
> >
134134
> > ```
135-
> >[18776] INFO These tasks will be executed: map/tas, timeseries/tas_global,
135+
> >[134535] INFO These tasks will be executed: map/tas, timeseries/tas_global,
136136
>>timeseries/script1, map/script1, timeseries/tas_amsterdam
137137
> > ```
138138
> >
@@ -368,7 +368,7 @@ Do you recognize the basic recipe structure that was introduced in episode 1?
368368
> > which contains preprocessed data for each of the input datasets, plus a
369369
> > combined `MultiModelMean`, a `metadata.yml` file and provenance files.
370370
> > - **map/script1**: creates `/run/map/script1` with general information and a
371-
> > log of the diagnostic script run. It also creates `/plots/map/script1` and
371+
> > log of the diagnostic script run. It also creates `/plots/map/script1/` and
372372
> > `/work/map/script1`, which contain output figures and output datasets,
373373
> > respectively. For each output file, there is also corresponding provenance
374374
> > information in the form of `.xml`, `.bibtex` and `.txt` files.

_episodes/05-conclusions.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Conclusion of the basic tutorial"
33
teaching: 10
44
exercises: 0
5-
compatibility: ESMValTool v2.8.0
5+
compatibility: ESMValTool v2.10.0
66

77
questions:
88
- "What do I do now?"
@@ -69,32 +69,32 @@ to be suitable for use by ESMValTool.
6969

7070
### Where can I get more help?
7171

72-
There are lots of resources available for helping you use ESMValTool.
72+
There are lots of resources available to assist you in using ESMValTool.
7373

7474
The ESMValTool [Discussions page](https://github.com/ESMValGroup/ESMValTool/discussions)
75-
is a good place to learn about general issues, or to see if your question has
76-
been already addressed.
77-
If you have a GitHub account, you can also post your questions on the page.
75+
is a good place to find information on general issues, or check
76+
if your question has already been addressed.
77+
If you have a GitHub account, you can also post your questions there.
7878

79-
If you get stuck, a great starting point is to create a
80-
[new issue](https://github.com/ESMValGroup/ESMValTool/issues/new/choose). Note
81-
that you will need a GitHub account for this.
79+
If you encounter difficulties, a great starting point is to visit issues page
80+
[issue page](https://github.com/ESMValGroup/ESMValTool/issues) to check
81+
whether your issues have already been reported or not. If they have been reported before,
82+
suggestions provided by developers can help you to solve the issues you encountered.
83+
Note that you will need a GitHub account for this.
8284

83-
There is also an ESMValTool email list.
85+
Additionally, there is an ESMValTool email list.
8486
Please see
85-
86-
[information](https://docs.esmvaltool.org/en/latest/introduction.html#user-mailing-list)
87-
88-
on how to subscribe to user mailing list.
87+
[information](https://docs.esmvaltool.org/en/latest/introduction.html#user-mailing-list)
88+
on how to subscribe to the user mailing list.
8989

9090
### What if I find a bug?
9191

92-
If you find a bug, please report it back to the ESMValTool team.
93-
This will help us fix it, so that you can continue working,
94-
but also it means that ESMValTool will be more stable for everyone else as well.
92+
If you find a bug, please report it to the ESMValTool team.
93+
This will help us fix issues, ensuring not only your uninterrupted workflow
94+
but also contributing to the overall stability of ESMValTool for all users.
9595

9696
To report a bug, please create a new issue using the
97-
[new issue page](https://github.com/ESMValGroup/ESMValTool/issues/new/choose).
97+
[issue page](https://github.com/ESMValGroup/ESMValTool/issues).
9898

9999
In your bug report, please describe the problem as clearly and as completely as possible.
100100
You may need to include a recipe or the output log as well.

0 commit comments

Comments
 (0)