@@ -3,15 +3,15 @@ title: "Configuration"
33teaching : 0
44exercises : 0
55questions :
6- - " What is the user configuration file and how can I use it?"
6+ - " What is the user configuration file and how should I use it?"
77objectives :
88- " Understand the contents of the user-config.yml file"
9- - " Prepare the user-config.yml file for use "
10- - " Configure ESMValTool to ignore some settings"
9+ - " Prepare a personalized user-config.yml file"
10+ - " Configure ESMValTool to use some settings"
1111keypoints :
1212- " The ``config-user.yml`` tells ESMValTool where to find input data."
13- - " ``rootpath`` determines root directory for input data."
14- - " ``output_dir`` is the destination directory."
13+ - " ``rootpath`` defines the root directory for the input data."
14+ - " ``output_dir`` defines the destination directory."
1515---
1616
1717## The configuration file
@@ -23,14 +23,14 @@ can be found in the root directory of the ESMValTool repository:
2323[ config-user-example.yml] ( https://github.com/ESMValGroup/ESMValTool/blob/master/config-user-example.yml ) .
2424
2525Let's download it to our working directory `` esmvaltool_tutorial ``
26- that is made during the [ Setup] ( https://esmvalgroup.github.io/tutorial/setup.html ) .
26+ that was created during the [ Setup] ( https://esmvalgroup.github.io/tutorial/setup.html ) .
2727To do that, click on
2828[ this link] ( https://raw.githubusercontent.com/ESMValGroup/ESMValTool/master/config-user-example.yml )
2929to see a raw version of the file, right-click and press `` save as `` ,
3030then you can rename it to `` config-user.yml `` and save it into the working directory
3131`` esmvaltool_tutorial `` .
3232
33- Now in a terminal , let's change our working directory to `` esmvaltool_tutorial `` .
33+ Now, let's change our working directory in a terminal window to `` esmvaltool_tutorial `` .
3434Then, we run a text editor called Nano to open the configuration file:
3535
3636~~~ bash
@@ -42,17 +42,17 @@ This file contains the information for:
4242
4343* Rootpath to input data
4444* Directory structure for the data from different projects
45- * Number of parallel tasks
45+ * Number of tasks that can be run in parallel
4646* Destination directory
4747* Auxiliary data directory
4848* Output settings
4949
50- > ## Which text editor
50+ > ## Text editor side note
5151>
5252> No matter what editor you use, you will need to know where it searches
5353 for and saves files. If you start it from the shell, it will (probably)
5454use your current working directory as its default location. We use `` nano ``
55- in examples because it is one of the least complex text editors.
55+ in examples here because it is one of the least complex text editors.
5656Press <kbd >ctrl</kbd > + <kbd >O</kbd > to save the file,
5757and then <kbd >ctrl</kbd > + <kbd >X</kbd > to exit `` nano `` .
5858{: .callout}
@@ -62,7 +62,7 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
6262ESMValTool uses several categories (in ESMValTool, this is referred to as projects)
6363for input data based on their source. The current categories in the configuration
6464file are mentioned below. For example, CMIP is used for a dataset from
65- the climate model intercomparison project whereas OBS for an observational dataset.
65+ the climate model intercomparison project whereas OBS is used for an observational dataset.
6666The `` rootpath `` specifies the directories where ESMValTool will look for input data.
6767For each category, you can define either one path or several paths as a list.
6868
@@ -82,7 +82,7 @@ rootpath:
8282
8383In this lesson, we will work with data from
8484[CMIP5](https://esgf-node.llnl.gov/projects/cmip5/).
85- We add the root path of the folder where data is available.
85+ We add the root path of the folder where our/your data is available.
8686
8787~~~YAML
8888 rootpath :
@@ -94,16 +94,17 @@ We add the root path of the folder where data is available.
9494>
9595> * To get the data (or its correct rootpath), check instruction in
9696[Setup]({{ page.root }}{% link setup.md %}).
97- > * For more information about setting the rootpath, you can visit the ESMValTool
97+ > * For more information about setting the rootpath, see also the ESMValTool
98+ For more information about setting the roothpath, see also ESMValTool...
9899[documentation](https://esmvaltool.readthedocs.io/projects/esmvalcore/en/latest/esmvalcore/datafinder.html).
99100{: .callout}
100101
101102# # Directory structure for the data from different projects
102103
103104Input data can be from various models, observations and reanalysis data that adhere
104105to the [CF/CMOR standard](https://cmor.llnl.gov/).
105- To set a directory, you can use one of the values of
106- ``default``, ``BADC``, ``DKRZ``, ``ETHZ``, .... Let's use ``default `` in our example :
106+ The ``drs`` setting describes the file structure.
107+ Let's use ``default`` for ``CMIP5 `` in our example here :
107108
108109~~~YAML
109110drs :
@@ -112,16 +113,19 @@ drs:
112113
113114> # # Available drs
114115>
115- > For more information about directories, you can visit the ESMValTool
116- [documentation](https://esmvaltool.readthedocs.io/projects/esmvalcore/en/latest/esmvalcore/config.html#developer-configuration-file).
116+ > The ``drs`` setting describes the file structure for several projects
117+ (e.g. ``CMIP6``, ``CMIP5``, ``obs4mips``, ``OBS6``, ``OBS``) on several key machines
118+ (e.g. ``BADC``, ``CP4CDS``, ``DKRZ``, ``ETHZ``, ``SMHI``, ``BSC``).
119+ For more information about ``drs``, you can visit the ESMValTool
120+ [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html#cmor-drs).
117121{: .callout}
118122
119123# # Number of parallel tasks
120124
121125This option enables you to perform parallel processing.
122126You can choose the number of tasks in parallel as
123- 1/2/3/4/... or you can set it to ``null`` that tells
124- ESMValTool to use the number of available CPUs :
127+ 1/2/3/4/... or you can set it to ``null``. That tells
128+ ESMValTool to use the maximum number of available CPUs :
125129
126130~~~YAML
127131
@@ -141,11 +145,11 @@ again to a reasonable number for the amount of memory available in your system.
141145
142146The destination directory is the rootpath where ESMValTool will store its output,
143147i.e. figures, data, logs, etc. With every run, ESMValTool automatically generates
144- a new output folder determined by the recipe name, and date and time using
148+ a new output folder determined by recipe name, and date and time using
145149the format : YYYYMMDD_HHMMSS.
146150This folder contains four further subfolders : ` ` plots``, ``preproc``, ``run``, ``work``.
147151
148- Let's name our destination directory as ``esmvaltool_output`` in the working directory :
152+ Let's name our destination directory ``esmvaltool_output`` in the working directory :
149153
150154~~~YAML
151155output_dir : ./esmvaltool_output
@@ -160,28 +164,28 @@ each run because most users will only need the results from the diagnostic scrip
160164> * ``run``: this folder includes all log files, a copy of the recipe,
161165a summary of the resource usage, and the settings.yml interface files,
162166resource_usage.txt and temporary files created by the diagnostic scripts.
163- > * ``work``: a place for any diagnostic script results that are not plots, e.g.
164- files in NetCDF format (depends on the diagnostic script).
167+ > * ``work``: this folder is a place for any diagnostic script results that
168+ are not plots, e.g. files in NetCDF format (depends on the diagnostic script).
165169>
166170> We explain more about output in the next
167171[lesson]({{ page.root }}{% link _episodes/04-toy-example.md %})
168172{: .callout}
169173
170174# # Auxiliary data directory
171175
172- The ``auxiliary_data_dir`` setting is the path to place any required
173- additional auxiliary data files. This location allows us to tell
176+ The ``auxiliary_data_dir`` setting is the path where any required
177+ additional auxiliary data files are stored . This location allows us to tell
174178the diagnostic script where to find the files if they can not be downloaded
175- at runtime. This option is not for model or observational datasets, rather
176- it is for data files used in plotting such as coastline descriptions and so on.
179+ at runtime. This option should not be used for model or observational datasets, but
180+ for data files (e.g. shape files) used in plotting such as coastline descriptions and so on.
177181
178182~~~YAML
179183auxiliary_data_dir : ~/auxiliary_data
180184~~~
181185
182186# # Output settings
183187
184- These settings are used to inform ESMValTool about your preference.
188+ These settings are used to inform ESMValTool about your preference about specific actions .
185189You can turn on or off the setting by ``true`` or ``false`` values.
186190Most of these settings are fairly self-explanatory, ie :
187191
@@ -216,9 +220,10 @@ profile_diagnostic: false
216220for example : config-user_formalised_runs.yml, config-user_debugging.yml
217221{: .callout}
218222>
219- > # # Different settings
223+ > # # Saving preprocessed data
220224>
221- > In the configuration file, which settings are useful to store preprocessed data?
225+ > In the configuration file, which settings are useful to make sure preprocessed data
226+ is stored when ESMValTool is run?
222227>
223228>> # # Solution
224229>>
0 commit comments