Skip to content

Commit fc2fd93

Browse files
committed
add more explanations about config file at the top
1 parent f58ac76 commit fc2fd93

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

_episodes/03-configuration.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ keypoints:
1616

1717
The ``config-user.yml`` configuration file contains all the global level information needed by ESMValTool to run.
1818
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.
19-
Make a copy and rename it to ``config-user.yml``:
19+
Let's change our working directory to ESMValTool, then make a copy of the file and rename it to ``config-user.yml``, then run a text editor called Nano to open it:
2020

2121
~~~
22+
cd ESMValTool
2223
cp config-user-example.yml config-user.yml
24+
nano config-user.yml
2325
~~~
2426
{: .source}
2527

@@ -31,6 +33,11 @@ This file contains the information for:
3133
* Auxiliary data directory
3234
* Output settings
3335

36+
> ## Which text editor
37+
>
38+
> No matter what editor you use, you will need to know where it searches for and saves files. If you start it from the shell, it will (probably) use your current working directory as its default location. We use ``nano`` in examples because it is one of the least complex text editors. Press <kbd>ctrl</kbd> + <kbd>O</kbd> to save the file, and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit nano.
39+
{: .callout}
40+
3441
## Rootpaths to input data
3542
ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source.
3643
The current categories in the configuration file are mentioned below. For example, CMIP is used for a dataset from the climate model intercomparison project whereas OBS for an observational dataset. The ``rootpath`` specifies the directories where ESMValTool will look for input data. For each category, you can define either one path or several paths as a list.

0 commit comments

Comments
 (0)