Skip to content

Commit cfbc4f9

Browse files
committed
add more text about projects, fix minor issue, change the instruction about working directory
1 parent 42fa29c commit cfbc4f9

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

_episodes/03-configuration.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,18 @@ title: "Configuration"
33
teaching: 0
44
exercises: 0
55
questions:
6-
- "What is the user configuration file and how should I use it?"
6+
- What is the user configuration file and how should I use it?
77

88
objectives:
9-
- "Understand the contents of the user-config.yml file"
10-
- "Prepare a personalized user-config.yml file"
11-
- "Configure ESMValTool to use some settings"
9+
- Understand the contents of the user-config.yml file
10+
- Prepare a personalized user-config.yml file
11+
- Configure ESMValTool to use some settings
1212

1313
keypoints:
14-
- "The ``config-user.yml`` tells ESMValTool where to find input data."
15-
- " ``rootpath`` defines the root directory for the input data."
16-
- " ``output_dir`` defines the destination directory."
14+
- The ``config-user.yml`` tells ESMValTool where to find input data.
15+
- "``rootpath`` defines the root directory for the input data."
16+
- "``output_dir`` defines the destination directory."
17+
1718
---
1819

1920
## The configuration file
@@ -24,8 +25,15 @@ needed by ESMValTool to run. This is an
2425
can be found in the root directory of the ESMValTool repository:
2526
[config-user-example.yml](https://github.com/ESMValGroup/ESMValTool/blob/master/config-user-example.yml).
2627

27-
Let's download it to our working directory ``esmvaltool_tutorial``
28-
that was created during the [Setup]({{ page.root }}{% link setup.md %}).
28+
First, we make a working directory ``esmvaltool_tutorial``.
29+
In a new terminal, run:
30+
31+
~~~bash
32+
mkdir esmvaltool_tutorial
33+
cd esmvaltool_tutorial
34+
~~~
35+
36+
Now, we download the configuration file to our working directory.
2937
To do that, click on
3038
[this link](https://raw.githubusercontent.com/ESMValGroup/ESMValTool/master/config-user-example.yml)
3139
to see a raw version of the file, right-click and press ``save as``,
@@ -36,7 +44,6 @@ Now, let's change our working directory in a terminal window to ``esmvaltool_tut
3644
Then, we run a text editor called Nano to have a look inside the configuration file:
3745

3846
~~~bash
39-
cd esmvaltool_tutorial
4047
nano config-user.yml
4148
~~~
4249

@@ -52,11 +59,11 @@ This file contains the information for:
5259
> ## Text editor side note
5360
>
5461
> No matter what editor you use, you will need to know where it searches
55-
for and saves files. If you start it from the shell, it will (probably)
56-
use your current working directory as its default location. We use ``nano``
57-
in examples here because it is one of the least complex text editors.
58-
Press <kbd>ctrl</kbd> + <kbd>O</kbd> to save the file,
59-
and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
62+
> for and saves files. If you start it from the shell, it will (probably)
63+
> use your current working directory as its default location. We use ``nano``
64+
> in examples here because it is one of the least complex text editors.
65+
> Press <kbd>ctrl</kbd> + <kbd>O</kbd> to save the file,
66+
> and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
6067
{: .callout}
6168

6269
## Rootpath to input data
@@ -65,6 +72,8 @@ ESMValTool uses several categories (in ESMValTool, this is referred to as projec
6572
for input data based on their source. The current categories in the configuration
6673
file are mentioned below. For example, CMIP is used for a dataset from
6774
the climate model intercomparison project whereas OBS is used for an observational dataset.
75+
We can find more information about the projects in the ESMValTool
76+
[documentation](https://docs.esmvaltool.org/en/latest/input.html).
6877
The ``rootpath`` specifies the directories where ESMValTool will look for input data.
6978
For each category, you can define either one path or several paths as a list.
7079

@@ -97,7 +106,6 @@ We add the root path of the folder where our/your data is available.
97106
> - To get the data (or its correct rootpath), check instruction in
98107
[Setup]({{ page.root }}{% link setup.md %}).
99108
> - For more information about setting the rootpath, see also the ESMValTool
100-
For more information about setting the roothpath, see also ESMValTool
101109
[documentation](https://esmvaltool.readthedocs.io/projects/esmvalcore/en/latest/esmvalcore/datafinder.html).
102110
{: .callout}
103111

0 commit comments

Comments
 (0)