Skip to content

Commit

Permalink
Suggested Documentation changes (#690)
Browse files Browse the repository at this point in the history
Update documentation on relative diagnostics paths and preprocessor order.

Co-authored-by: Bouwe Andela <[email protected]>
  • Loading branch information
ssmithClimate and bouweandela authored Jul 10, 2020
1 parent 64911eb commit aaadc73
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/quickstart/find_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ structures.

Explaining ``config-user/drs: CMIP5:`` or ``config-user/drs: CMIP6:``
---------------------------------------------------------------------
Whreas ESMValTool will **always** use the CMOR standard for file naming (please
Whereas ESMValTool will **always** use the CMOR standard for file naming (please
refer above), by setting the ``drs`` parameter the user tells the tool what
type of root paths they need the data from, e.g.:

Expand Down
9 changes: 9 additions & 0 deletions doc/recipe/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ arguments):
data, applying CMOR checks and fixes (:ref:`CMOR check and dataset-specific
fixes`) and saving the data to disk.

Preprocessor operations will be applied using the default order
as listed in :ref:`preprocessor_functions`.
Preprocessor tasks can be set to run in the order they are listed in the recipe
by adding ``custom_order: true`` to the preprocessor definition.

.. _Diagnostics:

Recipe section: ``diagnostics``
Expand Down Expand Up @@ -237,6 +242,10 @@ The path to the script provided in the ``script`` option should be
either the absolute path to the script, or the path relative to the
``esmvaltool/diag_scripts`` directory.

Depending on the installation configuration, you may get an error of
"file does not exist" when the system tries to run the diagnostic script
using relative paths. If this happens, use an absolute path instead.

Ancestor tasks
--------------
Some tasks require the result of other tasks to be ready before they can start,
Expand Down
3 changes: 2 additions & 1 deletion doc/recipe/preprocessor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ Overview
The ESMValTool preprocessor can be used to perform a broad range of operations
on the input data before diagnostics or metrics are applied. The preprocessor
performs these operations in a centralized, documented and efficient way, thus
reducing the data processing load on the diagnostics side.
reducing the data processing load on the diagnostics side. For an overview of
the preprocessor structure see the :ref:`Preprocessors`.

Each of the preprocessor operations is written in a dedicated python module and
all of them receive and return an Iris `cube
Expand Down

0 comments on commit aaadc73

Please sign in to comment.