Skip to content

Commit 0d741c7

Browse files
author
Klaus Zimmermann
committed
Reduce formatting changes
1 parent c8040ef commit 0d741c7

File tree

3 files changed

+71
-19
lines changed

3 files changed

+71
-19
lines changed

doc/develop/fixing_data.rst

+63-11
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ data that is read using
1010
ESMValCore also allows for some departures with compliance (see
1111
:ref:`cmor_check_strictness`). Beyond that situation, some datasets
1212
(either model or observations) contain (known) errors that would
13-
normally prevent them from being processed. The issues can be in the
14-
metadata describing the dataset and/or in the actual data. Typical
15-
examples of such errors are missing or wrong attributes (e.g.
16-
attribute ''units'' says 1e-9 but data are actually in 1e-6), missing
17-
or mislabeled coordinates (e.g. ''lev'' instead of ''plev'' or missing
13+
normally prevent them from being processed. The issues can be in
14+
the metadata describing the dataset and/or in the actual data.
15+
Typical examples of such errors are missing or wrong attributes (e.g.
16+
attribute ''units'' says 1e-9 but data are actually in 1e-6), missing or
17+
mislabeled coordinates (e.g. ''lev'' instead of ''plev'' or missing
1818
coordinate bounds like ''lat_bnds'') or problems with the actual data
1919
(e.g. cloud liquid water only instead of sum of liquid + ice as
2020
specified by the CMIP data request).
@@ -23,10 +23,19 @@ As an extreme case, some others data sources simply are not NetCDF
2323
files and must go through other data load function.
2424

2525
The ESMValCore can apply on the fly fixes to such datasets when
26-
issues can be fixed automatically. This is implemented for a set
27-
of `Natively supported non-CMIP datasets`_. The following provide
26+
issues can be fixed automatically. This is implemented for a set
27+
of `Natively supported non-CMIP datasets`_. The following provide
2828
details on how to design such fixes.
2929

30+
.. note::
31+
32+
**CMORizer scripts**. Support for many observational and reanalysis
33+
datasets is also possible through a priori reformatting by
34+
:ref:`CMORizer scripts in the ESMValTool <esmvaltool:new-dataset>`,
35+
which are rather relevant for datasets of small volume
36+
37+
.. _fix_structure:
38+
3039
.. note::
3140

3241
**CMORizer scripts**. Support for many observational and reanalysis
@@ -337,14 +346,23 @@ Natively supported non-CMIP datasets
337346
Some fixed datasets and native models formats are supported through
338347
the ``native6`` project or through a dedicated project.
339348
340-
.. _fixing_native_models:
349+
ERA5 and MSWEP datasets
350+
-----------------------
351+
Put the files containing the data in the directory that you have configured
352+
for the ``native6`` project in your :ref:`user configuration file`, in a
353+
subdirectory called ``Tier{tier}/{dataset}/{version}/{frequency}/{short_name}``.
354+
Replace the items in curly braces by the values used in the variable/dataset
355+
definition in the :ref:`recipe <recipe_overview>`.
356+
Below is a list of datasets currently supported.
357+
358+
ERA5
359+
~~~~
341360
342361
Native models : IPSL-CM6,...
343362
-----------------------------
344363
345-
The following models are natively supported through the procedure
346-
described above (:ref:`fix_structure`) and at
347-
:ref:`configure_native_models`:
364+
MSWEP
365+
~~~~~
348366
349367
- **IPSL-CM6** : both output formats (i.e. the ``Output`` and the
350368
``Analyse / Time series`` formats) are supported, and should be
@@ -402,6 +420,40 @@ datasets currently supported :
402420
403421
For more info: http://www.gloh2o.org/
404422
423+
.. _fixing_native_models:
424+
425+
Native models : IPSL-CM6,...
426+
-----------------------------
427+
428+
The following models are natively supported through the procedure
429+
described above (:ref:`fix_structure`) and at
430+
:ref:`configure_native_models`:
431+
432+
- **IPSL-CM6** : both output formats (i.e. the ``Output`` and the
433+
``Analyse / Time series`` formats) are supported, and should be
434+
configured in recipes as e.g.:
435+
436+
.. code-block:: yaml
437+
438+
datasets:
439+
- {simulation: CM61-LR-hist-03.1950, exp: piControl, freq: Analyse/TS_MO,
440+
account: p86caub, status: PROD, dataset: IPSL-CM6, project: IPSLCM,
441+
root: /thredds/tgcc/store}
442+
- {simulation: CM61-LR-hist-03.1950, exp: historical, freq: Output/MO,
443+
account: p86caub, status: PROD, dataset: IPSL-CM6, project: IPSLCM,
444+
root: /thredds/tgcc/store}
445+
446+
.. _ipslcm_extra_facets_example:
447+
448+
The ``Output`` format is an example of a case where variables are
449+
grouped in multi-variable files, which name cannot be computed
450+
directly from datasets attributes alone but requires to use an
451+
extra_facets file, which principles are explained in
452+
:ref:`extra_facets`, and which content is :download:`available here
453+
</../esmvalcore/_config/extra_facets/ipslcm-mappings.yml>`. These
454+
multi-variable files must also undergo some data selection, which
455+
may involve an external process for performance purpose.
456+
405457
.. _extra-facets-fixes:
406458
407459
Use of extra facets in fixes

doc/quickstart/configure.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,8 @@ It will be installed along with ESMValCore and can also be viewed on GitHub:
176176
`esmvalcore/config-developer.yml
177177
<https://github.com/ESMValGroup/ESMValCore/blob/main/esmvalcore/config-developer.yml>`_.
178178
This configuration file describes the file system structure and CMOR tables for several
179-
key projects (CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines (e.g.
180-
BADC, CP4CDS, DKRZ, ETHZ, SMHI, BSC), and for native output data for some
179+
key projects (CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines (e.g. BADC, CP4CDS, DKRZ,
180+
ETHZ, SMHI, BSC), and for native output data for some
181181
models (IPSL, ... see :ref:`configure_native_models`).
182182
CMIP data is stored as part of the Earth System Grid
183183
Federation (ESGF) and the standards for file naming and paths to files are set
@@ -293,13 +293,13 @@ related to CMOR table settings available:
293293
Defaults to the value provided in ``cmor_type``.
294294

295295
.. _configure_native_models:
296-
296+
297297
Configuring native models and observation data sets
298298
----------------------------------------------------
299299

300300
ESMValCore can be configured for handling native model output formats
301301
and specific
302-
observation data sets without preliminary reformating. You can choose
302+
observation data sets without preliminary reformatting. You can choose
303303
to host this new data source either under a dedicated project or under
304304
project ``native6``; when choosing the latter, such a configuration
305305
involves the following steps:
@@ -314,9 +314,9 @@ involves the following steps:
314314

315315
.. code-block:: yaml
316316
317-
native6:
318-
...
319-
input_dir:
317+
native6:
318+
...
319+
input_dir:
320320
default: 'Tier{tier}/{dataset}/{latestversion}/{frequency}/{short_name}'
321321
MY_DATA_ORG: '{model}/{exp}/{simulation}/{version}/{type}'
322322
input_file:

doc/quickstart/find_data.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ section.
5050

5151
Native model data
5252
---------------------------------------------------------
53-
Support for native model data that is not formatted according to a CMIP
53+
Support for native model data that is not formatted according to a CMIP
5454
data request is quite easy using basic
5555
:ref:`ESMValCore fix procedure <fixing_data>` and has been implemented
5656
for some models :ref:`as described here <fixing_native_models>`

0 commit comments

Comments
 (0)