Skip to content

Commit e070fd5

Browse files
axel-lauerbouweandelarbeucher
authored
Add info on obs tiers to docu (#3624)
Co-authored-by: Bouwe Andela <[email protected]> Co-authored-by: Romain Beucher <[email protected]>
1 parent de43833 commit e070fd5

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

‎doc/sphinx/source/input.rst‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,21 @@ ESMValTool currently supports two ways to perform this reformatting (aka
112112
checks and fixes'). Details on this second method are given at the
113113
:ref:`end of this chapter <inputdata_native_datasets>`.
114114

115+
Tiers
116+
-----
117+
118+
All observational datasets are grouped into in three tiers:
119+
120+
* **Tier 1**: obs4mips and ana4mips datasets. These datasets are publicly and freely available without any license restrictions. These datasets do not need any reformatting and can be used as is with ESMValTool.
121+
* **Tier 2** other freely available datasets that are not obs4mips. There are no license restrictions. These datasets need to be reformatted to be used with ESMValTool ('CMORization', see above).
122+
* **Tier 3** restricted datasets. Datasets which require registration to be downloaded or that can only be obtained upon request from the respective authors. License restrictions do not allow us to redistribute Tier 3 datasets. The data have to be obtained and reformatted by the user ('CMORization', see above).
123+
124+
[!NOTE]
125+
.. _tier3_note:
126+
For some of the Tier 3 datasets, we obtained permission from the dataset providers to share the data among ESMValTool users on HPC systems. These Tier 3 datasets are marked with an asterisk in the table in section :ref:`supported datasets below<supported_datasets>`.
127+
128+
An overview of the Tier 2 and Tier 3 datasets for which a CMORizing script is available in ESMValTool v2.0 is given in section :ref:`supported datasets below<supported_datasets>`.
129+
115130
A collection of readily CMORized OBS and OBS6 datasets can be accessed directly on CEDA/JASMIN and DKRZ. At CEDA/JASMIN
116131
OBS and OBS6 data is stored in the `esmeval` Group Workspace (GWS), and to be granted read (and execute) permissions to the
117132
GWS, one must apply at https://accounts.jasmin.ac.uk/services/group_workspaces/esmeval/ ; after permission has been granted, the user
@@ -246,7 +261,7 @@ A list of the datasets for which a CMORizers is available is provided in the fol
246261
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
247262
| CALIPSO-GOCCP | clcalipso (cfMon) | 2 | NCL |
248263
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
249-
| CALIPSO-ICECLOUD | cli (AMon) | 3 | NCL |
264+
| CALIPSO-ICECLOUD* [#t3]_ | cli (AMon) | 3 | NCL |
250265
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
251266
| CDS-SATELLITE-ALBEDO | bdalb (Lmon), bhalb (Lmon) | 3 | Python |
252267
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
@@ -330,7 +345,7 @@ A list of the datasets for which a CMORizers is available is provided in the fol
330345
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
331346
| ESRL | co2s (Amon) | 2 | NCL |
332347
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
333-
| FLUXCOM | gpp (Lmon) | 3 | Python |
348+
| FLUXCOM* [#t3]_ | gpp (Lmon) | 3 | Python |
334349
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
335350
| GCP2018 | fgco2 (Omon [#note3]_), nbp (Lmon [#note3]_) | 2 | Python |
336351
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
@@ -380,17 +395,17 @@ A list of the datasets for which a CMORizers is available is provided in the fol
380395
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
381396
| Landschuetzer2020 | spco2 (Omon) | 2 | Python |
382397
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
383-
| MAC-LWP | lwp, lwpStderr (Amon) | 3 | NCL |
398+
| MAC-LWP* [#t3]_ | lwp, lwpStderr (Amon) | 3 | NCL |
384399
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
385400
| MERRA | cli, clivi, clt, clw, clwvi, hur, hus, lwp, pr, prw, ps, psl, rlut, rlutcs, rsdt, rsut, rsutcs, ta, | 3 | NCL |
386401
| | tas, ts, ua, va, wap, zg (Amon) | | |
387402
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
388-
| MERRA2 | sm (Lmon) | 3 | Python |
403+
| MERRA2* [#t3]_ | sm (Lmon) | 3 | Python |
389404
| | clt, pr, evspsbl, hfss, hfls, huss, prc, prsn, prw, ps, psl, rlds, rldscs, rlus, rlut, rlutcs, rsds, | | |
390405
| | rsdscs, rsdt, tas, tasmin, tasmax, tauu, tauv, ts, uas, vas, rsus, rsuscs, rsut, rsutcs, ta, ua, va, | | |
391406
| | tro3, zg, hus, wap, hur, cl, clw, cli, clwvi, clivi (Amon) | | |
392407
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
393-
| MLS-AURA | hur, hurStderr (day) | 3 | Python |
408+
| MLS-AURA* [#t3]_ | hur, hurStderr (day) | 3 | Python |
394409
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
395410
| MOBO-DIC_MPIM | dissic (Omon) | 2 | Python |
396411
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
@@ -400,7 +415,7 @@ A list of the datasets for which a CMORizers is available is provided in the fol
400415
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
401416
| MSWEP [#note1]_ | pr | 3 | n/a |
402417
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
403-
| MTE | gpp, gppStderr (Lmon) | 3 | Python |
418+
| MTE* [#t3]_ | gpp, gppStderr (Lmon) | 3 | Python |
404419
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
405420
| NCEP-NCAR-R1 | clt, hur, hurs, hus, pr, prw, psl, rlut, rlutcs, rsut, rsutcs, sfcWind, ta, tas, | 2 | Python |
406421
| | tasmax, tasmin, ts, ua, va, wap, zg (Amon) | | |
@@ -410,7 +425,7 @@ A list of the datasets for which a CMORizers is available is provided in the fol
410425
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
411426
| NDP | cVeg (Lmon) | 3 | Python |
412427
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
413-
| NIWA-BS | toz, tozStderr (Amon) | 3 | NCL |
428+
| NIWA-BS* [#t3]_ | toz, tozStderr (Amon) | 3 | NCL |
414429
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
415430
| NOAA-CIRES-20CR-V2 | clt, clwvi, hus, prw, rlut, rsut, pr, tauu, tauv (Amon) | 2 | Python |
416431
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
@@ -448,14 +463,17 @@ A list of the datasets for which a CMORizers is available is provided in the fol
448463
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
449464
| TCOM-N2O | n2o (Amon [#note3]_) | 2 | Python |
450465
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
451-
| UWisc | clwvi, lwpStderr (Amon) | 3 | NCL |
466+
| UWisc* [#t3]_ | clwvi, lwpStderr (Amon) | 3 | NCL |
452467
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
453468
| WFDE5 | tas, pr (Amon, day) | 2 | Python |
454469
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
455470
| WOA | thetao, so, tos, sos (Omon) | 2 | Python |
456471
| | no3, o2, po4, si (Oyr) | | |
457472
+------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
458473

474+
.. [#t3] We obtained permission from the dataset provider to share this dataset
475+
among ESMValTool users on HPC systems.
476+
459477
.. [#note1] CMORization is built into ESMValTool through the native6 project,
460478
so there is no separate CMORizer script.
461479

0 commit comments

Comments
 (0)