You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _episodes/03-configuration.md
+32-16Lines changed: 32 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,34 +15,37 @@ keypoints:
15
15
## The configuration file
16
16
17
17
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.
19
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:
20
20
21
-
~~~
21
+
~~~bash
22
22
cd ESMValTool
23
23
cp config-user-example.yml config-user.yml
24
24
nano config-user.yml
25
25
~~~
26
+
26
27
{: .source}
27
28
28
29
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
35
37
36
38
> ## Which text editor
37
39
>
38
40
> 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
41
{: .callout}
40
42
41
43
## Rootpaths to input data
44
+
42
45
ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source.
43
46
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.
44
47
45
-
~~~
48
+
~~~YAML
46
49
rootpath:
47
50
CMIP3: [~/cmip3_inputpath1, ~/cmip3_inputpath2]
48
51
CMIP5: [~/cmip5_inputpath1, ~/cmip5_inputpath2]
@@ -55,16 +58,18 @@ rootpath:
55
58
RAWOBS: ~/rawobs_inputpath
56
59
default: ~/default_inputpath
57
60
~~~
61
+
58
62
{: .source}
59
63
60
64
In this lesson, you work with data from [CMIP5](https://esgf-node.llnl.gov/projects/cmip5/).
61
65
Add the root path of the folder where you downloaded the data during the [Setup](https://esmvalgroup.github.io/tutorial/setup.html).
@@ -73,12 +78,14 @@ Add the root path of the folder where you downloaded the data during the [Setup]
73
78
{: .callout}
74
79
75
80
## Directory structure for the data from different projects
81
+
76
82
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:
77
83
78
-
~~~
84
+
~~~YAML
79
85
drs:
80
86
CMIP5: default
81
87
~~~
88
+
82
89
{: .source}
83
90
84
91
> ## Available drs
@@ -87,11 +94,14 @@ drs:
87
94
{: .callout}
88
95
89
96
## Number of parallel tasks
97
+
90
98
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:
91
99
92
-
~~~
100
+
~~~YAML
101
+
93
102
max_parallel_tasks: null
94
103
~~~
104
+
95
105
{: .source}
96
106
97
107
> ## Set the number of tasks
@@ -100,13 +110,15 @@ max_parallel_tasks: null
100
110
{: .callout}
101
111
102
112
## Destination directory
113
+
103
114
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``.
104
115
105
116
Let's name our destination directory as ``esmvaltool_output`` in the working directory:
0 commit comments