Skip to content

Commit feace8b

Browse files
committed
update info about output settings
1 parent 2e037f1 commit feace8b

File tree

1 file changed

+27
-39
lines changed

1 file changed

+27
-39
lines changed

_episodes/03-configuration.md

Lines changed: 27 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Add the root path of the folder where you downloaded the data during the [Setup]
7373

7474
## Directory structure for the data from different projects
7575

76-
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:
76+
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:
7777

7878
~~~YAML
7979
drs:
@@ -121,51 +121,39 @@ output_dir: ./esmvaltool_output
121121

122122
## Auxiliary data directory
123123

124-
The ``auxiliary_data_dir`` setting is the path to place any required
125-
additional auxiliary data files. This method was necessary because certain
126-
Python toolkits such as cartopy will attempt to download data files at run
127-
time, typically geographic data files such as coastlines or land surface maps.
128-
This can fail if the machine does not have access to the wider internet. This
129-
location allows us to tell cartopy (and other similar tools) where to find the
130-
files if they can not be downloaded at runtime. To reiterate, this setting is
131-
not for model or observational datasets, rather it is for data files used in
132-
plotting such as coastline descriptions and so on.
124+
The ``auxiliary_data_dir`` setting is the path to place any required additional auxiliary data files. This location allows us to tell the diagnostic script where to find the files if they can not be downloaded at runtime. This option is not for model or observational datasets, rather it is for data files used in plotting such as coastline descriptions and so on.
133125

134126
~~~YAML
135127
auxiliary_data_dir: ~/auxiliary_data
136128
~~~
137129

138-
139130
## Output settings
140131

141-
.. code-block:: yaml
142-
143-
# Diagnostics create plots? [true]/false
144-
write_plots: true
145-
# Diagnositcs write NetCDF files? [true]/false
146-
write_netcdf: true
147-
148-
The ``write_plots`` setting is used to inform ESMValTool about your preference
149-
for saving figures. Similarly, the ``write_netcdf`` setting is a boolean which
150-
turns on or off the writing of netCDF files.
151-
152-
The ```rootpath`` specifies the directories where ESMValTool will look for input
153-
data. Similarly, ``output_dir`` specifies where ESMValTool will store its
154-
output, i.e. figures, data, logs, etc. Make sure to set appropriate paths.
155-
156-
.. code-block:: yaml
157-
158-
159-
160-
161-
You can tailor it for your system using the explanation below.
162-
163-
.. note::
164-
165-
The ``config-user.yml`` file is specified as argument at run time, so it is
166-
possible to have several available with different purposes: one for
167-
formalised runs, one for debugging, etc...
132+
These settings are used to inform ESMValTool about your preference. You can turn on or off the setting by ``true`` or ``false`` values. Most of these settings are fairly self-explanatory, ie:
168133

134+
~~~YAML
135+
# Diagnostics create plots? [true]/false
136+
write_plots: true
137+
# Diagnositcs write NetCDF files? [true]/false
138+
write_netcdf: true
139+
# Set the console log level debug, [info], warning, error
140+
log_level: info
141+
# Exit on warning (only for NCL diagnostic scripts)? true/[false]
142+
exit_on_warning: false
143+
# Plot file format? [png]/pdf/ps/eps/epsi
144+
output_file_type: png
145+
# Use netCDF compression true/[false]
146+
compress_netcdf: false
147+
# Save intermediary cubes in the preprocessor true/[false]
148+
save_intermediary_cubes: false
149+
# Remove the preproc dir if all fine
150+
remove_preproc_dir: true
151+
# Path to custom config-developer file, to customise project configurations.
152+
# See config-developer.yml for an example. Set to [null] to use the default
153+
# config_developer_file: null
154+
# Get profiling information for diagnostics
155+
# Only available for Python diagnostics
156+
profile_diagnostic: false
157+
~~~
169158

170159
{% include links.md %}
171-

0 commit comments

Comments
 (0)