Skip to content

Commit 5c1ed53

Browse files
committed
add explanation for roothpath
1 parent 93dbe0b commit 5c1ed53

File tree

1 file changed

+76
-1
lines changed

1 file changed

+76
-1
lines changed

_episodes/03-configuration.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,82 @@ objectives:
99
keypoints:
1010
- "First key point. Brief Answer to questions. (FIXME)"
1111
---
12-
FIXME
12+
13+
## The configuration file
14+
15+
The ``config-user.yml`` configuration file contains all the global level
16+
information needed by ESMValTool to run. 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.
17+
Make a copy and rename it to ``config-user.yml``.
18+
19+
~~~
20+
cp config-user-example.yml config-user.yml
21+
~~~
22+
{: .source}
23+
24+
This file contains:
25+
* Rootpaths to the data from different projects
26+
* Directory structure for input data
27+
* Number of available CPUs
28+
* Destination directory
29+
* Auxiliary data directory
30+
* Output settings
31+
32+
## Rootpaths to input data
33+
ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source, like CMIP for dataset from climate model intercomparison project, OBS for observational dataset that adhere to (CMOR standard)[https://cmor.llnl.gov/]
34+
For each category, you can define either one path or several pathes as a list.
35+
Add the root path of the folder where you downloaded the data during the (Setup)[https://escience-academy.github.io/lesson-esmvaltool/setup.html]
36+
37+
~~~
38+
rootpath:
39+
...
40+
CMIP5: [~/cmip5_inputpath1, ~/cmip5_inputpath2, ~/escience-academy/test_data]
41+
~~~
42+
{: .source}
43+
44+
## Auxiliary data directory (used for some additional datasets)
45+
auxiliary_data_dir: ~/auxiliary_data
46+
47+
The ``auxiliary_data_dir`` setting is the path to place any required
48+
additional auxiliary data files. This method was necessary because certain
49+
Python toolkits such as cartopy will attempt to download data files at run
50+
time, typically geographic data files such as coastlines or land surface maps.
51+
This can fail if the machine does not have access to the wider internet. This
52+
location allows us to tell cartopy (and other similar tools) where to find the
53+
files if they can not be downloaded at runtime. To reiterate, this setting is
54+
not for model or observational datasets, rather it is for data files used in
55+
plotting such as coastline descriptions and so on.
56+
57+
58+
## Output settings
59+
60+
.. code-block:: yaml
61+
62+
# Diagnostics create plots? [true]/false
63+
write_plots: true
64+
# Diagnositcs write NetCDF files? [true]/false
65+
write_netcdf: true
66+
67+
The ``write_plots`` setting is used to inform ESMValTool about your preference
68+
for saving figures. Similarly, the ``write_netcdf`` setting is a boolean which
69+
turns on or off the writing of netCDF files.
70+
71+
The ```rootpath`` specifies the directories where ESMValTool will look for input
72+
data. Similarly, ``output_dir`` specifies where ESMValTool will store its
73+
output, i.e. figures, data, logs, etc. Make sure to set appropriate paths.
74+
75+
.. code-block:: yaml
76+
77+
78+
79+
80+
You can tailor it for your system using the explanation below.
81+
82+
.. note::
83+
84+
The ``config-user.yml`` file is specified as argument at run time, so it is
85+
possible to have several available with different purposes: one for
86+
formalised runs, one for debugging, etc...
87+
1388

1489
{% include links.md %}
1590

0 commit comments

Comments
 (0)