Documentation for new CORDEX-CMIP6 project.

rigoudyg · Mar 8, 2024 · dfba992 · dfba992
1 parent 14f2d96
commit dfba992
Show file tree

Hide file tree

Showing 10 changed files with 202 additions and 27 deletions.
diff --git a/dr2xml/projects/CORDEX-CMIP6.py b/dr2xml/projects/CORDEX-CMIP6.py
@@ -63,7 +63,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
         key="conventions_version",
         default_values=[
             ValueSettings(key_type="config", keys="CMIP6_conventions_version")
-        ]
+        ],
+        help="Version of the conventions used."
     ),
     HDL=ParameterSettings(
         key="HDL",
@@ -86,7 +87,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 ],
                 fmt="r{}i{}p{}f{}"
             )
-        ]
+        ],
+        help="Label of the variant done."
     ),
     domain=ParameterSettings(
         key="domain",
@@ -98,7 +100,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                     ValueSettings(key_type="internal", keys="context")
                 ]
             )
-        ]
+        ],
+        help="Dictionary which contains, for each context, the associated domain."
     ),
     domain_id=ParameterSettings(
         key="domain_id",
@@ -110,7 +113,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                     ValueSettings(key_type="internal", keys="context")
                 ]
             )
-        ]
+        ],
+        help="Dictionary which contains, for each context, the associated domain id."
     ),
     version_realisation=ParameterSettings(
         key="version_realisation",
@@ -119,7 +123,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="version_realisation"
             )
-        ]
+        ],
+        help="Version of the realisation done."
     ),
     driving_source_id=ParameterSettings(
         key="driving_source_id",
@@ -128,7 +133,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="driving_source_id"
             )
-        ]
+        ],
+        help="Id of the driving model."
     ),
     driving_variant_label=ParameterSettings(
         key="driving_variant_label",
@@ -137,7 +143,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="driving_variant_label"
             )
-        ]
+        ],
+        help="Id of the driving variant."
     ),
     driving_experiment_id=ParameterSettings(
         key="driving_experiment_id",
@@ -146,7 +153,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="driving_experiment_id"
             )
-        ]
+        ],
+        help="Id of the experiment which drives the current simulation."
     ),
     driving_institution_id=ParameterSettings(
         key="driving_institution_id",
@@ -155,7 +163,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="driving_institution_id"
             )
-        ]
+        ],
+        help="Id of the institution of the driving model."
     ),
     driving_experiment=ParameterSettings(
         key="driving_experiment",
@@ -164,7 +173,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="driving_experiment"
             )
-        ]
+        ],
+        help="Id of the experiment which drives the current simulation."
     ),
     Lambert_conformal_longitude_of_central_meridian=ParameterSettings(
         key="Lambert_conformal_longitude_of_central_meridian",
@@ -173,7 +183,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="Lambert_conformal_longitude_of_central_meridian"
             )
-        ]
+        ],
+        help="Longitude of central meridian of the Lambert conformal projection."
     ),
     Lambert_conformal_standard_parallel=ParameterSettings(
         key="Lambert_conformal_standard_parallel",
@@ -182,7 +193,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="Lambert_conformal_standard_parallel"
             )
-        ]
+        ],
+        help="Standard parallel of the Lambert conformal projection."
     ),
     Lambert_conformal_latitude_of_projection_origin=ParameterSettings(
         key="Lambert_conformal_latitude_of_projection_origin",
@@ -191,7 +203,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="Lambert_conformal_latitude_of_projection_origin"
             )
-        ]
+        ],
+        help="Latitude of central meridian of the Lambert conformal projection."
     ),
     rcm_version_id=ParameterSettings(
         key="rcm_version_id",
@@ -200,7 +213,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                 key_type="simulation",
                 keys="rcm_version_id"
             )
-        ]
+        ],
+        help="Version id of the regional model used."
     )
 )
 
@@ -211,10 +225,12 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
         comments_constraints=dict(
             CV_version=ParameterSettings(
                 key="CV_version",
+                help="Controled vocabulary version used.",
                 default_values=["CMIP6-CV version ??", ]
             ),
             conventions_version=ParameterSettings(
                 key="conventions_version",
+                help="Conventions version used.",
                 default_values=[
                     ValueSettings(key_type="common", keys="conventions_version", fmt="CMIP6_conventions_version {}")
                 ]
@@ -270,53 +286,65 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
             ),
             nominal_resolution=ParameterSettings(
                 key="nominal_resolution",
-                output_key="native_resolution"
+                output_key="native_resolution",
+                help="Nominal resolution of the model."
+            ),
+            driving_institution_id=ParameterSettings(
+                key="driving_institution_id",
+                help="Id of the institution of the driving model."
             ),
             version_realisation=ParameterSettings(
                 key="version_realisation",
                 default_values=[
                     ValueSettings(key_type="common", keys="version_realisation")
-                ]
+                ],
+                help="Version of the realisation done."
             ),
             domain=ParameterSettings(
                 key="domain",
                 default_values=[
                     ValueSettings(key_type="common", keys="domain")
-                ]
+                ],
+                help="Dictionary which contains, for each context, the associated domain."
             ),
             domain_id=ParameterSettings(
                 key="domain_id",
                 default_values=[
                     ValueSettings(key_type="common", keys="domain_id")
-                ]
+                ],
+                help="Dictionary which contains, for each context, the associated domain id."
             ),
             driving_source_id=ParameterSettings(
                 key="driving_source_id",
                 default_values=[
                     ValueSettings(key_type="common", keys="driving_source_id")
                 ],
-                fatal=True
+                fatal=True,
+                help="Member of the simulation which drives the simulation."
             ),
             driving_variant_label=ParameterSettings(
                 key="driving_variant_label",
                 default_values=[
                     ValueSettings(key_type="common", keys="driving_variant_label")
                 ],
-                fatal=True
+                fatal=True,
+                help="Id of the driving variant."
             ),
             driving_experiment_id=ParameterSettings(
                 key="driving_experiment_id",
                 default_values=[
                     ValueSettings(key_type="common", keys="driving_experiment_id")
                 ],
-                fatal=True
+                fatal=True,
+                help="Id of the experiment which drives the current simulation."
             ),
             driving_experiment=ParameterSettings(
                 key="driving_experiment",
                 default_values=[
                     ValueSettings(key_type="common", keys="driving_experiment")
                 ],
-                fatal=True
+                fatal=True,
+                help="Id of the experiment which drives the current simulation."
             ),
             Lambert_conformal_longitude_of_central_meridian=ParameterSettings(
                 key="Lambert_conformal_longitude_of_central_meridian",
@@ -329,7 +357,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                         check_value=ValueSettings(key_type="internal", keys="context"),
                         check_to_do="eq", reference_values="surfex"
                     )
-                ]
+                ],
+                help="Longitude of central meridian of the Lambert conformal projection."
             ),
             Lambert_conformal_standard_parallel=ParameterSettings(
                 key="Lambert_conformal_standard_parallel",
@@ -342,7 +371,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                         check_value=ValueSettings(key_type="internal", keys="context"),
                         check_to_do="eq", reference_values="surfex"
                     )
-                ]
+                ],
+                help="Standard parallel of the Lambert conformal projection."
             ),
             Lambert_conformal_latitude_of_projection_origin=ParameterSettings(
                 key="Lambert_conformal_latitude_of_projection_origin",
@@ -355,7 +385,8 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
                         check_value=ValueSettings(key_type="internal", keys="context"),
                         check_to_do="eq", reference_values="surfex"
                     )
-                ]
+                ],
+                help="Latitude of central meridian of the Lambert conformal projection."
             ),
             product=ParameterSettings(
                 key="product",
@@ -411,6 +442,7 @@ def build_filename(frequency, prefix, source_id, expid_in_filename, date_range,
         vars_constraints=dict(
             grid_mapping=ParameterSettings(
                 key="grid_mapping",
+                help="Grid mapping associated with the file.",
                 default_values=["Lambert_Conformal", ],
                 conditions=[
                     ConditionSettings(check_value=ValueSettings(key_type="internal", keys="context"),

diff --git a/dr2xml/projects/basics.py b/dr2xml/projects/basics.py
@@ -584,7 +584,8 @@ def compute_nb_days(year_ref, year_branch, month_ref=1, month_branch=1, day_ref=
                 default_values=[
                     ValueSettings(key_type="internal", keys="synchronisation_frequency")
                 ],
-                skip_values=["None", "", None]
+                skip_values=["None", "", None],
+                help="Frequency at which the synchornisation between buffer and filesystem is done."
             ),
             convention_str=ParameterSettings(
                 key="convention_str",

diff --git a/dr2xml/projects/dr2xml.py b/dr2xml/projects/dr2xml.py
@@ -23,6 +23,7 @@
 	),
 	synchronisation_frequency=ParameterSettings(
 		key="synchronisation_frequency",
+		help="Frequency at which the synchornisation between buffer and filesystem is done.",
 		default_value=[
 			ValueSettings(key_type="simulation", keys="synchronisation_frequency"),
 			ValueSettings(key_type="laboratory", keys="synchronisation_frequency"),

diff --git a/sphinx/source/userguide/parameters.rst b/sphinx/source/userguide/parameters.rst
@@ -7,7 +7,8 @@ Parameters available in settings
 
    dr2xml project <projects/dr2xml>
    basics project <projects/basics>
+   ping project <projects/ping>
    C3S-SF project <projects/C3S-SF>
    CMIP6 project <projects/CMIP6>
+   CORDEX-CMIP6 project <projects/CORDEX-CMIP6>
    CORDEX project <projects/CORDEX>
-   ping project <projects/ping>
diff --git a/sphinx/source/userguide/projects/C3S-SF.rst b/sphinx/source/userguide/projects/C3S-SF.rst
@@ -963,6 +963,16 @@ Internal values
 
       num type: 'string'
 
+   synchronisation_frequency
+
+      Frequency at which the synchornisation between buffer and filesystem is done.
+
+      fatal: False
+
+      default values: []
+
+      num type: 'string'
+
    tierMax
 
       Number indicating the maximum tier to consider for experiments.
@@ -2900,6 +2910,22 @@ Project settings
 
             num type: 'string'
 
+         synchronisation_frequency
+
+            Frequency at which the synchornisation between buffer and filesystem is done.
+
+            fatal: False
+
+            default values: internal[synchronisation_frequency]
+
+            skip values:
+
+               - 'None'
+               - ''
+               - None
+
+            num type: 'string'
+
 
       Variables
          description

diff --git a/sphinx/source/userguide/projects/CMIP6.rst b/sphinx/source/userguide/projects/CMIP6.rst
@@ -967,6 +967,16 @@ Internal values
 
       num type: 'string'
 
+   synchronisation_frequency
+
+      Frequency at which the synchornisation between buffer and filesystem is done.
+
+      fatal: False
+
+      default values: []
+
+      num type: 'string'
+
    tierMax
 
       Number indicating the maximum tier to consider for experiments.
@@ -3034,6 +3044,22 @@ Project settings
 
             num type: 'string'
 
+         synchronisation_frequency
+
+            Frequency at which the synchornisation between buffer and filesystem is done.
+
+            fatal: False
+
+            default values: internal[synchronisation_frequency]
+
+            skip values:
+
+               - 'None'
+               - ''
+               - None
+
+            num type: 'string'
+
 
       Variables
          activity_id