Skip to content

Commit 3ee6ff5

Browse files
committed
update the content on how to get config file
1 parent e506f9a commit 3ee6ff5

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

_episodes/03-configuration.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,31 @@ exercises: 0
55
questions:
66
- "What is the user configuration file and how can I use it?"
77
objectives:
8-
- "Understand the data directories structure"
8+
- "Understand the contents of the user-config.yml file"
9+
- "Prepare the user-config.yml file for use"
910
- "Configure ESMValTool to ignore some settings"
1011
keypoints:
11-
- "The ``config-user.yml`` tells ESMValTool about input, output and your preference."
12+
- "The ``config-user.yml`` tells ESMValTool where to find input data."
1213
- " ``rootpath`` determines root directory for input data."
1314
- " ``output_dir`` is the destination directory."
1415
---
1516

17+
Contents:
18+
19+
Exercise: Copy the user config to your working area
20+
Exercise: Make site specific configuration information(ie the changes needed to you config-user.yml file before you can run)
21+
1622
## The configuration file
1723

1824
The ``config-user.yml`` configuration file contains all the global level information needed by ESMValTool to run.
19-
This is an [YAML file](https://yaml.org/spec/1.2/spec.html). An example configuration file can be found in the root directory of the ESMValTool repository.
20-
Let's change our working directory to ``esmvaltool_tutorial`` that is made during the [Setup](https://esmvalgroup.github.io/tutorial/setup.html). Then we copy the config file and rename it to ``config-user.yml``, then run a text editor called Nano to open it:
25+
This is an [YAML file](https://yaml.org/spec/1.2/spec.html). An example configuration file can be found in the [root directory of the ESMValTool repository](https://github.com/ESMValGroup/ESMValTool/blob/master/config-user-example.yml).
26+
Let's download it in our working directory ``esmvaltool_tutorial`` that is made during the [Setup](https://esmvalgroup.github.io/tutorial/setup.html).
27+
Click on [this link](https://raw.githubusercontent.com/ESMValGroup/ESMValTool/master/config-user-example.yml) to see a raw version of the file, right-click and press save as, then you can rename it to ``config-user.yml`` and save it into the working directory ``esmvaltool_tutorial``.
28+
29+
Lets change our working directory to ``esmvaltool_tutorial``. Then, we run a text editor called Nano to open it:
2130

2231
~~~bash
2332
cd esmvaltool_tutorial
24-
cp ESMValTool/config-user-example.yml config-user.yml
2533
nano config-user.yml
2634
~~~
2735

0 commit comments

Comments
 (0)