Skip to content

Commit 4502a82

Browse files
committed
run a mardownlinter and fix the errors
1 parent dfbb869 commit 4502a82

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

_episodes/03-configuration.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,37 @@ keypoints:
1515
## The configuration file
1616

1717
The ``config-user.yml`` configuration file contains all the global level information needed by ESMValTool to run.
18-
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.
18+
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.
1919
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

21-
~~~
21+
~~~bash
2222
cd ESMValTool
2323
cp config-user-example.yml config-user.yml
2424
nano config-user.yml
2525
~~~
26+
2627
{: .source}
2728

2829
This file contains the information for:
29-
* Rootpath to input data
30-
* Directory structure for the data from different projects
31-
* Number of parallel tasks
32-
* Destination directory
33-
* Auxiliary data directory
34-
* Output settings
30+
31+
* Rootpath to input data
32+
* Directory structure for the data from different projects
33+
* Number of parallel tasks
34+
* Destination directory
35+
* Auxiliary data directory
36+
* Output settings
3537

3638
> ## Which text editor
3739
>
3840
> 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.
3941
{: .callout}
4042

4143
## Rootpaths to input data
44+
4245
ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source.
4346
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.
4447

45-
~~~
48+
~~~YAML
4649
rootpath:
4750
CMIP3: [~/cmip3_inputpath1, ~/cmip3_inputpath2]
4851
CMIP5: [~/cmip5_inputpath1, ~/cmip5_inputpath2]
@@ -55,16 +58,18 @@ rootpath:
5558
RAWOBS: ~/rawobs_inputpath
5659
default: ~/default_inputpath
5760
~~~
61+
5862
{: .source}
5963

6064
In this lesson, you work with data from [CMIP5](https://esgf-node.llnl.gov/projects/cmip5/).
6165
Add the root path of the folder where you downloaded the data during the [Setup](https://esmvalgroup.github.io/tutorial/setup.html).
6266

63-
~~~
67+
~~~YAML
6468
rootpath:
6569
...
6670
CMIP5: [~/cmip5_inputpath1, ~/cmip5_inputpath2, ~/tutorial/test_data]
6771
~~~
72+
6873
{: .source}
6974

7075
> ## Setting the correct rootpath
@@ -73,12 +78,14 @@ Add the root path of the folder where you downloaded the data during the [Setup]
7378
{: .callout}
7479

7580
## Directory structure for the data from different projects
81+
7682
Input data can be from various models, observations and reanalysis data that adhere to the [CF/CMOR standard](https://cmor.llnl.gov/). To set a directory, you can use one of the values of ``default``, ``BADC``, ``DKRZ``, ``ETHZ``, ... . Let's use ``default`` in our example:
7783

78-
~~~
84+
~~~YAML
7985
drs:
8086
CMIP5: default
8187
~~~
88+
8289
{: .source}
8390

8491
> ## Available drs
@@ -87,11 +94,14 @@ drs:
8794
{: .callout}
8895

8996
## Number of parallel tasks
97+
9098
This option enables you to perform parallel processing. You can choose the number of tasks in parallel as 1/2/3/4/... or you can set it to ``null`` that tells ESMValTool to use the number of available CPUs:
9199

92-
~~~
100+
~~~YAML
101+
93102
max_parallel_tasks: null
94103
~~~
104+
95105
{: .source}
96106

97107
> ## Set the number of tasks
@@ -100,13 +110,15 @@ max_parallel_tasks: null
100110
{: .callout}
101111

102112
## Destination directory
113+
103114
The destination directory is the rootpath where ESMValTool will store its output, i.e. figures, data, logs, etc. With every run, ESMValTool automatically generates a new output folder determined by the recipe name, and date and time using the format: YYYYMMDD_HHMMSS. This folder contains four further subfolders: ``plots``, ``preproc``, ``run``, ``work``.
104115

105116
Let's name our destination directory as ``esmvaltool_output`` in the working directory:
106117

107-
~~~
118+
~~~YAML
108119
output_dir: ./esmvaltool_output
109120
~~~
121+
110122
{: .source}
111123

112124
> ## Content of subfolders
@@ -119,9 +131,7 @@ output_dir: ./esmvaltool_output
119131
> We explain more about output in the next [lesson](https://esmvalgroup.github.io/tutorial/04-toy-example/index.html)
120132
{: .callout}
121133

122-
123-
## Auxiliary data directory (used for some additional datasets)
124-
auxiliary_data_dir: ~/auxiliary_data
134+
## Auxiliary data directory
125135

126136
The ``auxiliary_data_dir`` setting is the path to place any required
127137
additional auxiliary data files. This method was necessary because certain
@@ -133,6 +143,12 @@ files if they can not be downloaded at runtime. To reiterate, this setting is
133143
not for model or observational datasets, rather it is for data files used in
134144
plotting such as coastline descriptions and so on.
135145

146+
~~~YAML
147+
auxiliary_data_dir: ~/auxiliary_data
148+
~~~
149+
150+
{: .source}
151+
136152

137153
## Output settings
138154

0 commit comments

Comments
 (0)