Skip to content

Commit dfbb869

Browse files
committed
add info about destination dir
1 parent 7acb55d commit dfbb869

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

_episodes/03-configuration.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,27 @@ max_parallel_tasks: null
9999
> If you run out of memory, try setting ``max_parallel_tasks`` to 1. Then, check the amount of memory you need for that by inspecting the file ``run/resource_usage.txt`` in the output directory. Using the number there you can increase the number of parallel tasks again to a reasonable number for the amount of memory available in your system.
100100
{: .callout}
101101

102+
## Destination directory
103+
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+
105+
Let's name our destination directory as ``esmvaltool_output`` in the working directory:
106+
107+
~~~
108+
output_dir: ./esmvaltool_output
109+
~~~
110+
{: .source}
111+
112+
> ## Content of subfolders
113+
>
114+
> * ``plots``: the location for all plots, split by individual diagnostics and fields.
115+
> * ``preproc``: this folder contains all the preprocessed data and metadata.yml interface files. Note that by default this directory will be deleted after each run because most users will only need the results from the diagnostic scripts.
116+
> * ``run``: this folder includes all log files, a copy of the recipe, a summary of the resource usage, and the settings.yml interface files, resource_usage.txt and temporary files created by the diagnostic scripts.
117+
> * ``work``: a place for any diagnostic script results that are not plots, e.g. files in NetCDF format (depends on the diagnostic script).
118+
>
119+
> We explain more about output in the next [lesson](https://esmvalgroup.github.io/tutorial/04-toy-example/index.html)
120+
{: .callout}
121+
122+
102123
## Auxiliary data directory (used for some additional datasets)
103124
auxiliary_data_dir: ~/auxiliary_data
104125

0 commit comments

Comments
 (0)