diff --git a/dr2xml/dr_interface/CMIP7_config b/dr2xml/dr_interface/CMIP7_config index 26bd01e4..6e8550da 100644 --- a/dr2xml/dr_interface/CMIP7_config +++ b/dr2xml/dr_interface/CMIP7_config @@ -1,3 +1,4 @@ +cache_dir: /home/rigoudyg/dev/data_request/CMIP7_DReq_Software/data_request_api/data_request_api/content/dreq_api/dreq_res check_api_version: false consolidate: false export: release diff --git a/dr2xml/projects/dr2xml.py b/dr2xml/projects/dr2xml.py index 248ea6db..1dd4ca6d 100644 --- a/dr2xml/projects/dr2xml.py +++ b/dr2xml/projects/dr2xml.py @@ -84,7 +84,7 @@ def sort_mips(*mips): ), synchronisation_frequency=ParameterSettings( key="synchronisation_frequency", - help="Frequency at which the synchornisation between buffer and filesystem is done.", + help="Frequency at which the synchronisation 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/dr2xml/projects/projects_interface_definitions.py b/dr2xml/projects/projects_interface_definitions.py index 9793cb07..0312ddc4 100644 --- a/dr2xml/projects/projects_interface_definitions.py +++ b/dr2xml/projects/projects_interface_definitions.py @@ -346,7 +346,7 @@ def init_dict_default(self): return dict(skip_values=list(), forbidden_patterns=list(), conditions=list(), default_values=list(), cases=list(), authorized_values=list(), authorized_types=list(), corrections=dict(), output_key=None, num_type="string", is_default=False, fatal=False, key=None, help="TODO", - target_type=None) + target_type=None, section=None) def dump_doc(self, force_void=False): rep = list() diff --git a/dr2xml/settings_interface/py_project_interface.py b/dr2xml/settings_interface/py_project_interface.py index ada81070..45ccd23c 100644 --- a/dr2xml/settings_interface/py_project_interface.py +++ b/dr2xml/settings_interface/py_project_interface.py @@ -7,6 +7,7 @@ from __future__ import print_function, division, absolute_import, unicode_literals import os +from collections import defaultdict from importlib.machinery import SourceFileLoader from .py_settings_interface import get_variable_from_lset_with_default_in_lset, get_variable_from_lset_with_default, \ @@ -32,26 +33,52 @@ def initialize_project_settings(dirname, doc_writer=False): return internal_values, common_values, project_settings -def write_project_documentation(internal_values, common_values, project_settings, dirname, project): - target_filename = os.sep.join([dirname, project + ".rst"]) +def write_project_dict_content(list_values, title, title_level, level=0): content = list() - content.append("Parameters available for project %s" % project) - content.append("=" * len(content[0])) - content.append("") - content.append("Internal values") - content.append("---------------") + content.append(title) + content.append(title_level * len(title)) content.append(".. glossary::") content.append(" :sorted:") content.append(" ") + content.extend(list_values) + content = [" " * level + elt for elt in content] + return content + + +def write_project_documentation(internal_values, common_values, project_settings, dirname, project): + param_content = defaultdict(lambda: defaultdict(list)) for value in sorted(list(internal_values)): - content.extend(internal_values[value].dump_doc()) - content.append("Common values") - content.append("-------------") - content.append(".. glossary::") - content.append(" :sorted:") - content.append(" ") + param_content[internal_values[value].section]["internal"].extend(internal_values[value].dump_doc()) for value in sorted(list(common_values)): - content.extend(common_values[value].dump_doc()) + param_content[common_values[value].section]["common"].extend(common_values[value].dump_doc()) + list_sections = list(param_content) + if None in list_sections: + list_sections.remove(None) + list_sections = sorted(list_sections) + list_sections.insert(0, None) + else: + list_sections = sorted(list_sections) + target_filename = os.sep.join([dirname, project + ".rst"]) + content = list() + content.append("Parameters available for project %s" % project) + content.append("=" * len(content[0])) + content.append("") + + for section in list_sections: + if section is None: + section_title = "Unsorted parameters" + else: + section_title = section + level = 1 + title_level = "^" + content.append(section_title) + content.append("-" * len(section_title)) + if "internal" in param_content[section]: + content.extend(write_project_dict_content(param_content[section]["internal"], "Internal values", title_level, level=level)) + if "common" in param_content[section]: + content.extend(write_project_dict_content(param_content[section]["common"], "Common values", title_level, level=level)) + if section is not None: + content.append("") content.append("Project settings") content.append("----------------") content.append(".. glossary::") diff --git a/sphinx/source/userguide/configuration.rst b/sphinx/source/userguide/configuration.rst index 03880c2f..994cfc7d 100644 --- a/sphinx/source/userguide/configuration.rst +++ b/sphinx/source/userguide/configuration.rst @@ -26,7 +26,7 @@ default values can be found. Currently, three types of Data Request can be used in dr2xml: - the CMIP6 Data Request (default one) - - a C3S seasonal forecast kind of Data Request (python-like file with defined entries) + - a C3S seasonal forecast kind of Data Request (json-like file with defined entries) - no Data Request (in this case, the definitions of the variables are given through json-like tables and everything must be defined) @@ -45,10 +45,11 @@ Beside those projects, the ones available currently for "real" usage are: - :module:`dr2xml.projects.CORDEX-CMIP6` for CORDEX-CMIP6 kind' usages - :module:`dr2xml.projects.C3S-SF` for C3S seasonal forecast kind' usages -The settings defined in the projects are splitted in three categories (determined in this order): - - the internal settings which are required to run dr2xml - - the common settings which are used after having be read once at the launch of dr2xml - - for each XIOS-related object, the settings associated with this object (attributes and meta-data) +The settings defined in the projects are splitted in four categories (determined in this order): + - the init settings which are required to initialize dr2xml + - the internal settings which are required to run dr2xml (need init settings to get the right values) + - the common settings which are only used in the XIOS-related objects settings (not properly in dr2xml source code), can use init and internal settings values + - for each XIOS-related object, the settings associated with this object (attributes and meta-data), some common values are regrouped at this level too That means that a setting in the common list can be defined from an other one in the internal list but not the reverse. The lab and model settings diff --git a/sphinx/source/userguide/how_to.rst b/sphinx/source/userguide/how_to.rst new file mode 100644 index 00000000..8a5add4d --- /dev/null +++ b/sphinx/source/userguide/how_to.rst @@ -0,0 +1,77 @@ +How to start with a new model/laboratory? +========================================= + +This section aims at giving a few tips to start with the use of dr2xml with a new model/laboratory. + +First, from where to start? +--------------------------- + +The first step is to have XIOS working in the targetted model. +One it is the case, that's means that you have many of the initialized files needed (fields, grids...). + +Then, the simplest way to start with dr2xml is to use an existing configuration and to adapt it. +The notebook `DR2xml.ipynb` or the script `examples/DR2xml.py` are good starting points as long as unitary tests. + +Deal with a new laboratory +-------------------------- + +The short name of the new laboratory is specified in the lab_and_model_settings.py using the `institution_id` key. +It is used to get information from outer sources (including CVs for CMIP6) to determine metadada and also to determine +which variables should be output or not following lab grid policy. Lab grid policy can be seen as a first set of +filtering on grids on which variables are output. + +For CNRM-CERFACS, the file is already included in the repository under `dr2xml.laboratories.CNRM-CERFACS.py`. +For other groups, this file must be created (can be a copy of the CNRM-CERFACS one's with the new lab's name) and adapted if needed. +The location of this file should be added in lab_and_model_settings.py using key `laboratory_used`). +It can also be integrated in the repository. + +Other keys such as `contact` will have to be updated (but it is not mandatory at this stage). + +Creating ping files +------------------- + +Ping files are used to make the link between the names defined in the fields definitions (i.e. the 'model' names) and the names defined in the data request. +Example of ping files are in tests/common/xml_files directory. + +To create ping files, you can use the notebook `create_ping_files.ipynb` or adapt the tests under tests/test_pingfiles_*. + +Deal with a new model +--------------------- + +Then, the next step is to define the model within the lab_and_model_settings.py file. + +First, the different grids of the model (if several, list all), must defined in `grids` and `sizes` for each context as +long as the sampling timestep in `sampling_timestep`. You must also defined the list of mips associated with each grid +in `mips` (can be a void set if no filtering should be applied). + +Then, for each model id, you must provide: + - the grid associated with this model `grid_choice` (if a model is associated with several grids, you must provide two different ids) + - the types of sources associated with each model using `source_types` + - for child simulations, the start year in parent simulation must be provided in `branching` + - the `configuration` should also be updated + +Deal with a new project +----------------------- + +If you need to configure your output for an other project, it's the most tricky part of dr2xml. + +The different projects usable with dr2xml can be found in `dr2xml.projects`. + +The base one is `dr2xml.projects.dr2xml.json` which come with some functions in `dr2xml.projects.dr2xml_funcs.py`. +All others must inherit from it as it defines all elements that are needed to run dr2xml. + +The second base is `dr2xml.projects.basics.json` which come with some functions in `dr2xml.projects.basics_funcs.py`. +All others (except dr2xml ones) should inherit from it too, as it give default values to all elements needed to run +dr2xml (where the dr2xml files defines them). This class can be used as it but do not have all attributes you may need. + +For your new project, if possible, start from an existing one, as close as possible as what is needed for you. +Then, copy the settings (json and py) and rename them with the id of your project. You need then to modify it to fit +with the requirements of your project. See the configuration section to have more elements. + +And then? +--------- + +You should now be able to start playing with dr2xml for your model. + +Keep in mind that dr2xml will try to take into account all the requirements you give but may fail and just set a +warning if it does not manage to find everything. \ No newline at end of file diff --git a/sphinx/source/userguide/index.rst b/sphinx/source/userguide/index.rst index 8708d322..2fbcb2ca 100644 --- a/sphinx/source/userguide/index.rst +++ b/sphinx/source/userguide/index.rst @@ -14,4 +14,5 @@ DR2XML User Guide Ping file Home data request Supplementary + How to start with a new model/laboratory? Acknowledgments \ No newline at end of file diff --git a/sphinx/source/userguide/parameters_old.rst b/sphinx/source/userguide/parameters_old.rst deleted file mode 100644 index 09b7732d..00000000 --- a/sphinx/source/userguide/parameters_old.rst +++ /dev/null @@ -1,813 +0,0 @@ -Parameters available in settings -================================ - -Legend ------- - -Requirements -^^^^^^^^^^^^ -.. glossary:: - - always required - required when relevant - never required - never required but recommended - -Parameter type -^^^^^^^^^^^^^^ -.. glossary:: - - string - dictionary - integer - list - boolean - regexp - -Location -^^^^^^^^ -.. glossary:: - - lab_and_model_settings - simulation_settings - -Available parameters --------------------- - -.. glossary:: - :sorted: - - institution_id - [:term:`string`, :term:`always required`, :term:`lab_and_model_settings`] - - Institution identifier. - - .. todo:: - - Should be read from Controlled Vocabulary if up-to-date. - - source_types - [:term:`dictionary`, :term:`required_when_relevant`, :term:`lab_and_model_settings`] - - A dictionary in which keys are models and values the associated :term:`source_type`. - - .. todo:: - - Should be read from Controlled Vocabulary if up-to-date. - - configurations - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`required_if_relevant`] - - A dictionary in which keys are configurations and values the associated triplet - (:term:`model_id`, :term:`source_type`, :term:`unused_contexts`). - - .. tip:: - - Must be defined jointly with :term:`configuration` if :term:`source_id` and/or :term:`source_types` are not defined - - info_url - [:term:`string`, :term:`lab_and_model_settings`, :term:`always_required`] - - Location of documentation. - - contact - [:term:`string`, :term:`never required`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=None] - - Email address of the data producer. - - mips - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - comment - [:term:`string`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=``] - - A character string containing additional information about the models. - Will be complemented with the experiment's specific comment string. - - max_priority - [:term:`integer`, :term:`lab_and_model_settings` and :term:`simulation_settings`, :term:`always_required`] - - Max variable priority level to be output (you may set 3 when creating ping_files while - being more restrictive at run time). - - tierMax - [:term:`integer`, :term:`lab_and_model_settings` and :term:`simulation_settings`, :term:`always_required`] - - Number indicating the maximum tier to consider for experiments. - - ping_variables_prefix - [:term:`string`, :term:`lab_and_model_settings`, :term:`always_required`] - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; - may be an empty string. - - excluded_vars - [:term:`list`, :term:`lab_and_model_settings` and :term:`simulation_settings`, :term:`always_required`, default=list()] - - List of CMOR variables to exclude from the result based on previous Data Request extraction. - - .. todo:: - - Fix the issue if not provided. - - special_timestep_vars - [:term:`dictionary`, :term:`lab_and_model_settings`, default=list()] - - This variable is used when some variables are computed with a period which is not the basic timestep. - A dictionary which keys are non standard timestep and values the list of variables - which are computed at this timestep. - - excluded_pairs - [:term:`list`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=list()] - - You can exclude some (variable, table) pairs from outputs. - A list of tuple (variable, table) to be exlcuded. - - excluded_vars_per_config - [:term:`dictionary`, :term:`lab_and_model_settings`] - - A dictionary which keys are configurations and values the list of variables - that must be excluded for each configuration. - - excluded_spshapes - [:term:`list`, :term:`lab_and_model_settings`, :term:`always_required`] - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - included_tables - [:term:`list`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=list()] - - List of tables that will be processed (all others will not). - - excluded_tables - [:term:`list`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=list()] - - List of the tables that will be excluded from outputs. - - excluded_request_links - [:term:`list`, :term:`lab_and_model_settings`, defaut=list()] - - List of links un data request that should not been followed (those request are not taken into account). - - .. tip:: - - There is an issue if RFMIP-Aeroirf is not in this list. - - included_request_links - [:term:`list`, :term:`lab_and_model_settings`, default=list()] - - List of the request links that will be processed (all others will not). - - listof_home_vars - [:term:`string`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=None] - - Full path to the file which contains the list of home variables to be taken into account, - in addition to the Data Request. - - path_extra_tables - [:term:`string`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=None] - - Full path of the directory which contains extra tables. - - realms_per_context - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - A dictionary which keys are context names and values the lists of realms associated with each context - - orphan_variables - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - A dictionary with (context name, list of variables) as (key,value) pairs, - where the list indicates the variables to be re-affected to the key-context - (initially affected to a realm falling in another context) - - comments - [:term:`dictionary`, :term:`lab_and_model_settings` and :term:`simulation_settings`, :term:`always_required`] - - A dictionary which keys are CMOR variable names and values a free comment the user wants to associate - to the key variable. Can be void. - - grid_choice - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - A dictionary which keys are models name and values the corresponding resolution. - - filter_on_realization - [:term:`boolean`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=True] - - If you want to produce the same variables set for all members, set this parameter to False. - - sizes - [:term:`dictionary`, :term:`lab_and_model_settings`, :term::`always_required`] - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. - The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. - Used to compute file split frequency. - - max_split_freq - [:term:`integer`, :term:`lab_and_model_settings` and :term:`simulation_settings`, default=None] - - The maximum number of years that should be putted in a single file. - - max_file_size_in_floats - [:term:`integer`, :term:`lab_and_model_settings`, default=500*1e6] - - The maximum size of generated files in number of floating values. - - .. todo:: check issues if not provided - - compression_level - [:term:`integer`, :term:`lab_and_model_settings`, default=0] - - The compression level to be applied to NetCDF output files. - - bytes_per_float - [:term:`integer`, :term:`lab_and_model_settings`, default=2] - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - grid_policy - [:term:`string`, :term:`lab_and_model_settings`, :term:`always_required`, - allowed=None, "DR", "native", "native+DR", "adhoc"] - - The grid choice policy for output files. - - grids - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - Grids : per model resolution and per context : - - CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you - may choose has main production grid a regular one, when the native grid is e.g. unstructured) - - Xios id for the production grid (if it is not the native grid), - - Xios id for the latitude axis used for zonal means (mist match latitudes for grid above) - - resolution of the production grid (using CMIP6 conventions), - - grid description - - sampling_timestep - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). - Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - CFsubhr_frequency - [:term:`string`, :term:`lab_and_model_settings`, default=`1ts`] - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - vertical_interpolation_sample_freq - [:term:`string`, :term:`lab_and_model_settings`, default=`always_required`] - - Time frequency of vertical interpolation. - - vertical_interpolation_operation - [:term:`string`, :term:`lab_and_model_settings`, default=`instant`] - - Operation done for vertical interpolation. - - use_union_zoom - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - too_long_periods - [:term:`list`, :term:`lab_and_model_settings`, default=list()] - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will - be labelled with dates consistent with content (but not with CMIP6 requirements). - Allowed values are only 'dec' and 'yr'. - - branching - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`required_when_relevant`] - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice - (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). - Just put the as key the common start year in child and as value the list of start years in parent - for all members. - A dictionary with models name as key and dictionary containing experiment, - (branch year in child, list of branch year in parent) key values. - - output_level - [:term:`integer`, :term:`lab_and_model_settings`, default=10] - - We can control the max output level set for all output files. - - print_variables - [:term:`boolean` or :term:`list`, :term:`lab_and_model_settings`, default=True] - - If the value is a list, only the file/field variables listed here will be put in output files. - If boolean, tell if the file/field variables should be put in output files. - - nemo_sources_management_policy_master_of_the_world - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets - a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, - that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - non_standard_attributes - [:term:`dictionary`, :term:`lab_and_model_settings`, default=OrderedDict()] - - You may add a series of NetCDF attributes in all files for this simulation - - simple_domain_grid_regexp - [:term:`regexp`, :term:`lab_and_model_settings`, :term:`always_required`] - - If some grid is not defined in xml but by API, and is referenced by a - field which is considered by the DR as having a singleton dimension, then: - - 1) it must be a grid which has only a domain - 2) the domain name must be extractable from the grid_id using a regexp and a group number - - Example: using a pattern that returns full id except for a '_grid' suffix - - .. todo:: - - Check if still used. - - non_standard_axes - [:term:`dictionary`, :term:`lab_and_model_settings`, default=DefaultDict()] - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that - it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide - the list of labels, ordered as in your model, as second element of a pair. - Label-type axes will be processed even if not quoted. - Scalar dimensions are not concerned by this feature. - - A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - dr2xml_manages_enddate - [:term:`boolean`, :term:`lab_and_model_settings`, default=True] - - A smart workflow will allow you to extend a simulation during it course and to complement the output files - accordingly, by managing the 'end date' part in filenames. - You can then set next setting to False. - - fx_from_file - [:term:`dictionary`, :term:`lab_and_model_settings`, default=list()] - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. - The varname in file must match the referenced id in pingfile. Tested only for fixed fields. - - A dictionary with variable id as key and a dictionary as value: - the key must be the grid id, the value a dictionary with the file for each resolution. - - path_to_parse - [:term:`string`, :term:`lab_and_model_settings`, default="./"] - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - allow_duplicates - [:term:`boolean`, :term:`lab_and_model_settings`, default=True] - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the - table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - allow_duplicates_in_same_table - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - Should we allow for another type of duplicate vars : two vars with same name in same table - (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in - 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. - If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - use_cmorvar_label_in_filename - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar - label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; - allows to avoid that, if set to True. - - add_Gibraltar - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. - Can include it, if model provides it as last value of array. - - debug_parsing - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - In order to identify which xml files generates a problem, you can use this flag. - - allow_pseudo_standard_names - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, - i.e. not yet approved labels. Default is to use only CF ones. - - print_stats_per_var_label - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - For an extended printout of selected CMOR variables, grouped by variable label. - - allow_tos_3hr_1deg - [:term:`boolean`, :term:`lab_and_model_settings`, default=True] - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - adhoc_policy_do_add_1deg_grid_for_tos - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. - If you use grid_policy=adhoc and had not changed the mapping of function. - grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request - to also produce tos on a 1 degree grid. - - mip_era - [:term:`string`, :term:`lab_and_model_settings` and :term:`simulation_settings`, - default=value from DR or home variable] - - .. todo:: - - Add a description of the parameter. - - experiment_id - [:term:`string`, :term:`simulation_settings`, :term:`always required`] - - Root experiment identifier. - - expid_in_filename - [:term:`string`, :term:`simulation_settings`, default=:term:`experiment_id`] - - Experiment label to use in file names and attribute. - - experiment_for_requests - [:term:`string`, :term:`simulation_settings`, default=:term:`experiment_id`] - - Experiment id to use for driving the use of the Data Request. - - configuration - [:term:`string`, :term:`simulation_settings`, :term:`required_when_relevant`] - - If there is no configuration in lab_settings which matches you case, please rather - use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - .. tip:: - - Must be defined jointly with :term:`configurations` if :term:`source_id` and/or :term:`source_types` are not defined - - included_vars - [:term:`list`, :term:`simulation_settings` and :term:`lab_and_model_settings`, default=list()] - - - It is possible to define the list of included vars in simulation settings. - If it is done, it replace the list which could be defined in laboratory settings. - - source_id - [:term:`string`, :term:`simulation_settings`, :term:`required_when_relevant`] - - Name of the model used. - - source_type - [:term:`string`, :term:`simulation_settings`, :term:`required_when_relevant`] - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) - does not fit, you may change it here. - "This should describe the model most directly responsible for the output. Sometimes it is appropriate to list - two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB " - e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". - Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - .. tip:: - - Needed if :term:`source_id` and/or :term:`source_types` are not defined. - - project - [:term:`string`, :term:`simulation_settings`, default: "CMIP6"] - - Project associated with the simulation. - - variant_info - [:term:`string`, :term:`simulation_settings`, :term:`never required but recommended`, default=`none`] - - It is recommended that some description be included to help identify major differences among variants, but care - should be taken to record correct information. dr2xml will add in all cases: - 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and - up-to-date documentation via the further_info_url global attribute.' - - realization_index - [:term:`integer`, :term:`simulation_settings`, :term:`always required`, default=1] - - Realization number. - - .. todo:: - - Check why the default value do not work, should not be always required. - - initialization_index - [:term:`integer`, :term:`simulation_settings`, default=1] - - Index for variant of initialization method. - - physics_index - [:term:`integer`, :term:`simulation_settings`, default=1] - - Index for model physics variant. - - forcing_index - [:term:`integer`, :term:`simulation_settings`, default=1] - - Index for variant of forcing. - - branch_method - [:term:`string`, :term:`simulation_settings`, :term:`required when relevant`, default="standard"] - - Branching procedure. - - parent_time_ref_year - [:term:`string`, :term:`simulation_settings`, default=`1850`] - - .. todo:: - - Add a description of the parameter. - - branch_year_in_parent - [:term:`integer`, :term:`simulation_settings`] - - .. todo:: - - Add a description of the parameter. - - branch_month_in_parent - [:term:`integer`, :term:`simulation_settings`, default=1] - - .. todo:: - - Add a description of the parameter. - - branch_time_in_parent - [:term:`string`, :term:`simulation_settings`, :term:`required when relevant`, default=`double`] - - Branch time with respect to parent's time axis. - - .. tip:: - - If this parameter is not provided, an non blocking error will be raised. - .. todo:: - - Turn this error into a warning. - - parent_time_units - [:term:`string`, :term:`simulation_settings`, default="days since :term:`parent_time_ref_year`-01-01 00:00:00"] - - Time units used in parent. - - branch_year_in_child - [:term:`integer`, :term:`simulation_settings`, :term:`always_required`] - - In some instances, the experiment start year is not explicit or is doubtful in DR. See - file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting - in order that requestItems analysis work in all cases - - In some other cases, DR requestItems which apply to the experiment form its start does not - cover its whole duration and have a wrong duration (computed based on a wrong start year); - They necessitate to fix the start year. - - .. todo:: - - Check wy error occurs if not specified, should be :term:`required_when_relevant` - - end_year - [:term:`integer`, :term:`simulation_settings`, default=value from DR] - - If you want to carry on the experiment beyond the duration set in DR, and that all - requestItems that apply to DR end year also apply later on, set 'end_year' - You can also set it if you don't know if DR has a wrong value - - child_time_ref_year - [:term:`integer`, :term:`simulation_settings`, :term:`required_when_relevant`] - - .. todo:: - - Add a description of the parameter. - - branch_time_in_child - [:term:`string`, :term:`simulation_settings`, :term:`required when relevant`, default=`double`] - - Branch time with respect to child's time axis - - parent_variant_label - [:term:`string`, :term:`simulation_settings`, defaut=:term:`variant_label`] - - Parent variant label - - parent_mip_era - [:term:`string`, :term:`simulation_settings`, default=:term:`mip_era`] - - Parent’s associated MIP cycle - - parent_source_id - [:term:`string`, :term:`simulation_settings`, default=:term:`source_id`] - - Parent model identifier - - sub_experiment_id - [:term:`string`, :term:`simulation_settings`, default=`none`] - - Sub-experiment identifier - - sub_experiment - [:term:`string`, :term:`simulation_settings`, default=`none`] - - history - [:term:`string`, :term:`simulation_settings`, :term:`never required`, default=`none`] - - In case of replacement of previously produced data, description of any changes in the production chain. - - bypass_CV_components - [:term:`boolean`, :term:`simulation_settings`, default=False] - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set - next toggle to True - - model_id - [:term:`string`, :term:`simulation_settings`] - - Model identifier. - - activity_id - [:term:`string`, :term:`simulation_settings` and :term:`lab_and_model_settings`, - default=value in controlled vocabulary for experiment] - - MIP(s) name(s) - - parent_experiment_id - [:term:`string`, :term:`simulation_settings` and :term:`lab_and_model_settings`, - default=value from controoled vocabulary of experiment] - - Parent experiment identifier. - - parent_activity_id - [:term:`string`, :term:`simulation_settings`, :term:`required when relevant`] - - Description of sub-experiment - - useAtForInstant - - [:term:`boolean`, :term:`lab_and_model_settings`, default=False] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - sectors - - [:term:`lab_and_model_settings`] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - grids_dev - - [:term:`dictionary`, :term:`lab_and_model_settings`, :term:`always_required`] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - Should not be required. - - institution - - [:term:`string`, :term:`lab_and_model_settings`] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - source - - [:term:`string`, :term:`lab_and_model_settings`, default=value from controlled vocabulary for source_id] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - CORDEX_data - - [:term:`boolean`, :term:`required_when_relevant`, :term:`simulation_settings`, default=False] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - perso_sdims_description - - [:term:`simulation_settings`, default=OrderedDict()] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - experiment - - [:term:`string`, :term:`simulation_settings`, default=value from controlled vocabulary for experiment] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - description - - [:term:`string`, :term:`simulation_settings`, default=value from controlled vocabulary for experiment] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - driving_model_id - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - driving_model_ensemble_member - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - driving_experiment - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - driving_experiment_name - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - Lambert_conformal_longitude_of_central_meridian - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - Lambert_conformal_standard_parallel - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - Lambert_conformal_latitude_of_projection_origin - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - rcm_version_id - - [:term:`string`, :term:`required_when_relevant`, :term:`simulation_settings`] - - For CORDEX purpose. - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - split_frequencies - - [:term:`string`, :term:`simulation_settings` and :term:`lab_and_model_settings`, default=`splitfreqs.dat`] - - .. todo:: - - Add a description of the parameter (and check that it is still used). - - HDL - .. todo:: - - Add a description of the parameter (and check that it is still used). diff --git a/sphinx/source/userguide/projects/C3S-SF.rst b/sphinx/source/userguide/projects/C3S-SF.rst index a2ce2bfc..bb203d17 100644 --- a/sphinx/source/userguide/projects/C3S-SF.rst +++ b/sphinx/source/userguide/projects/C3S-SF.rst @@ -1,2553 +1,2555 @@ Parameters available for project C3S-SF ======================================= -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: + fatal: False - - laboratory[additional_allowed_model_components][internal[source_id]] - - [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + num type: 'string' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + add_Gibraltar - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + fatal: False - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + num type: 'string' - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + fatal: True - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + default values: + + - laboratory[additional_allowed_model_components][internal[source_id]] + - [] - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + num type: 'string' - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + fatal: False - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + fatal: True - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + allow_pseudo_standard_names - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + fatal: False - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + allow_tos_3hr_1deg - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + fatal: False - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + branching - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + fatal: False - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + num type: 'string' - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + bypass_CV_components - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + fatal: False - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + num type: 'string' - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + bytes_per_float - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + fatal: False - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + configuration - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + fatal: True - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + default values: simulation[configuration] - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: + num type: 'string' - - laboratory[required_model_components][internal[source_id]] - - [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + context - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + Context associated with the xml file produced. - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + fatal: True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' + + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - Case: + - laboratory[data_request_content_version] + - 'latest_stable' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_path] + - None + + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_used] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[debug_parsing] + - False + + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - Case: + - laboratory[dr2xml_manages_enddate] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - simulation[end_year] + - False + + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - value: internal[excluded_request_links] + - simulation[excluded_opportunities] + - [] + + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: None + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: internal[grid_choice] + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: 'LR' + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vars] + - [] + + num type: 'string' + + institution_id + + Institution identifier. + + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + listof_home_vars - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vargroups_lset] - - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vars] + fatal: False + + default values: - Case: + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - value: internal[included_vars_lset] + - laboratory[max_file_size_in_floats] + - 500000000.0 + + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[max_priority] + - internal[max_priority_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - value: internal[max_priority] + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None + + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - Case: + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - value: internal[max_priority_lset] + - laboratory[non_standard_attributes] + - {} + + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[non_standard_axes] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - value: internal[mips][internal[select_grid_choice]]sort_mips() + - laboratory[orography_field_name] + - 'orog' + + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - Case: + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - value: internal[mips]sort_mips() + - laboratory[path_to_parse] + - './' + + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - simulation[perso_sdims_description] + - {} - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - value: True + - laboratory[print_stats_per_var_label] + - False + + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - Case: + - laboratory[print_variables] + - True - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - value: False + - laboratory[project] + - 'CMIP6' + + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[project_settings] + - internal[project] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - value: internal[year] + - simulation[realization_index] + - '1' + + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: - Case: + - laboratory[required_model_components][internal[source_id]] + - [] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: laboratory[sampling_timestep] + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - value: None + - laboratory[save_project_settings] + - None + + num type: 'string' + + sectors + + List of the sectors to be considered. + + fatal: False + + default values: laboratory[sectors] + + num type: 'string' + + select + + Selection strategy for variables. + + fatal: True + + default values: dict[select] + + authorized values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - 'on_expt_and_year' + - 'on_expt' + - 'no' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + select_excluded_opportunities + + Excluded opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[sizes] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' - - reference values: False - - - value: None - - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[tierMax] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + select_excluded_request_links - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + Excluded request links for variable selection. - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: [] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + num type: 'string' - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + select_excluded_tables - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + Excluded tables for variable selection. - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + fatal: True - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + default values: [] - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + - - simulation[HDL] - - laboratory[HDL] - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + num type: 'string' - - simulation[activity_id] - - laboratory[activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + select_excluded_vargroups - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + Excluded variables groups for variable selection. - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + fatal: True - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + default values: [] - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'eq' - - reference values: internal[branching] - - Condition: - - check value: simulation[branch_year_in_parent] - - check to do: 'eq' - - reference values: internal[branching][internal[experiment_id]][1] - + cases: + Case: - value: simulation[branch_year_in_parent] - - Case: - - conditions: - Condition: - - check value: internal[experiment_id] + conditions: + Condition: - check to do: 'neq' - - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - commit - - Id of the commits associated with the model. - - fatal: False - - default values: + select_grid_choice - - simulation[commit] - - laboratory[commit] - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + Grid choice for variable selection. - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: laboratory[sizes][internal[grid_choice]]format_sizes() + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: - default values: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab + + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - laboratory[comment] + - '' + + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + commit + + Id of the commits associated with the model. + + fatal: False + + default values: + + - simulation[commit] + - laboratory[commit] + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: laboratory[convention_str] + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' + + dr2xml_version + + Version of dr2xml used. + + fatal: False + + default values: dr2xml.config.version + + num type: 'string' + + experiment + + Name of the experiment. + + fatal: False + + default values: simulation[experiment] + + num type: 'string' + + expid_in_filename + + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + forecast_reference_time + + Reference time for the forecast done in the simulation. + + fatal: False + + default values: simulation[forecast_reference_time] + + num type: 'string' + + forecast_type + + Type of forecast done. + + fatal: False + + default values: simulation[forecast_type] + + num type: 'string' + + grid_mapping + + Grid mapping name. + + fatal: False + + default values: simulation[grid_mapping] + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: laboratory[institution] + + num type: 'string' + + keywords + + Keywords associated with the simulation. + + fatal: False + + default values: + + - simulation[keywords]build_string_from_list() + - laboratory[summary]build_string_from_list() + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: laboratory[convention_str] - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False - - default values: + default values: 'dr2xml_list_perso_and_dev_file_names' - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + num type: 'string' - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + mip_era - - simulation[forcing_index] - - '1' - - num type: 'string' - - forecast_reference_time - - Reference time for the forecast done in the simulation. - - fatal: False - - default values: simulation[forecast_reference_time] - - num type: 'string' - - forecast_type - - Type of forecast done. - - fatal: False - - default values: simulation[forecast_type] - - num type: 'string' - - grid_mapping - - Grid mapping name. - - fatal: False - - default values: simulation[grid_mapping] - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + MIP associated with the simulation. - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + fatal: False - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: laboratory[institution] - - num type: 'string' - - keywords - - Keywords associated with the simulation. - - fatal: False - - default values: + default values: + + - simulation[mip_era] + - laboratory[mip_era] - - simulation[keywords]build_string_from_list() - - laboratory[summary]build_string_from_list() - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + num type: 'string' - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + output_level - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + We can control the max output level set for all output files. - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + fatal: False - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False - - default values: + default values: + + - laboratory[output_level] + - '10' - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + num type: 'string' - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + parent_activity_id - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + Description of sub-experiment. - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - summary - - Short explanation about the simulation. - - fatal: False - - default values: + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + summary + + Short explanation about the simulation. + + fatal: False + + default values: + + - simulation[summary] + - laboratory[summary] + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' - - simulation[summary] - - laboratory[summary] - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/CMIP6.rst b/sphinx/source/userguide/projects/CMIP6.rst index c93f5815..be772b65 100644 --- a/sphinx/source/userguide/projects/CMIP6.rst +++ b/sphinx/source/userguide/projects/CMIP6.rst @@ -1,2543 +1,2545 @@ Parameters available for project CMIP6 ====================================== -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - CV_experiment - - Controlled vocabulary file containing experiment characteristics. - - fatal: False - - default values: read_json_file('{}{}_experiment_id.json'.format(dict[cvspath], internal[project]))[experiment_id][internal[experiment_id]] - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: internal[CV_experiment][additional_allowed_model_components] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + fatal: False - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + num type: 'string' - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + CV_experiment - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + Controlled vocabulary file containing experiment characteristics. - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + fatal: False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + default values: read_json_file('{}{}_experiment_id.json'.format(dict[cvspath], internal[project]))[experiment_id][internal[experiment_id]] - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + num type: 'string' - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + add_Gibraltar - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + fatal: False - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + num type: 'string' - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + additional_allowed_model_components - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + fatal: True - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + default values: internal[CV_experiment][additional_allowed_model_components] - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + allow_duplicates_in_same_table - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + fatal: True - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + allow_pseudo_standard_names - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + num type: 'string' - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + allow_tos_3hr_1deg - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + num type: 'string' - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + fatal: False - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + num type: 'string' - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + branching - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + fatal: False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + bypass_CV_components - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + fatal: False - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + bytes_per_float - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + fatal: False - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: internal[CV_experiment][required_model_components] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + num type: 'string' - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + configuration - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] - - Case: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[excluded_opportunities_lset] + fatal: True + + default values: simulation[configuration] + + num type: 'string' + + context + + Context associated with the xml file produced. + + fatal: True + + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[data_request_content_version] + - 'latest_stable' + + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - Case: + - laboratory[data_request_path] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - laboratory[data_request_used] + - 'CMIP6' + + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[debug_parsing] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - value: internal[excluded_request_links] + - laboratory[dr2xml_manages_enddate] + - True + + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - Case: + - simulation[end_year] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[excluded_opportunities] + - [] + + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_pairs] + - [] + + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[grid_choice] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: 'LR' + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: internal[included_opportunities] + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + included_vars_lset - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vargroups_lset] - - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + Variables to be considered from the Data Request (all others will not) from laboratory settings. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vars] - - Case: + fatal: False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vars_lset] + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[max_priority] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[max_priority_lset] - - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + institution_id - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[mips][internal[select_grid_choice]]sort_mips() - - Case: + Institution identifier. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[mips]sort_mips() + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + listof_home_vars + + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: - value: True + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None + + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - Case: + - laboratory[max_file_size_in_floats] + - 500000000.0 - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - value: False + - simulation[max_priority] + - internal[max_priority_lset] + + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - value: internal[year] + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False + + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - Case: + - laboratory[non_standard_attributes] + - {} - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - value: None + - laboratory[non_standard_axes] + - {} + + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[orography_field_name] + - 'orog' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - value: internal[sizes] + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None + + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - Case: + - laboratory[path_to_parse] + - './' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - value: None + - simulation[perso_sdims_description] + - {} + + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[print_stats_per_var_label] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - value: internal[tierMax] + - laboratory[print_variables] + - True + + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - Case: + - laboratory[project] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - value: internal[tierMax_lset] + - laboratory[project_settings] + - internal[project] + + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + - simulation[realization_index] + - '1' - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + realms_per_context - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + A dictionary which keys are context names and values the lists of realms associated with each context - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: laboratory[realms_per_context][internal[context]] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + num type: 'string' - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + required_model_components - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + Dictionary which gives, for each model name, the components that must be present. - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + fatal: True - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + default values: internal[CV_experiment][required_model_components] - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + sampling_timestep - - simulation[HDL] - - laboratory[HDL] - - '21.14100' - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - simulation[activity_id] - - laboratory[activity_id] - - internal[CV_experiment][activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + fatal: True - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + default values: laboratory[sampling_timestep] - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + num type: 'string' - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + save_project_settings - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'eq' - - reference values: internal[branching] - - Condition: - - check value: simulation[branch_year_in_parent] - - check to do: 'eq' - - reference values: internal[branching][internal[experiment_id]][1] - - - value: simulation[branch_year_in_parent] - - Case: + The path of the file where the complete project settings will be written, if needed. - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'neq' - - reference values: internal[branching] - - - value: simulation[branch_year_in_parent] + fatal: False + + default values: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + - laboratory[save_project_settings] + - None - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + sectors - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + List of the sectors to be considered. - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - conventions_version - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.CMIP6_conventions_version - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False - - default values: + fatal: False - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + default values: laboratory[sectors] - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + num type: 'string' - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + select - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + Selection strategy for variables. - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: + fatal: True - - laboratory[institution] - - read_json_file('{}{}_institution_id.json'.format(dict[cvspath], internal[project]))[institution_id][internal[institution_id]] - - num type: 'string' - - license - - File where the license associated with the produced output files can be found. - - fatal: False - - default values: read_json_file('{}{}_license.json'.format(dict[cvspath], internal[project]))[license][0] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - member_id - - Id of the member done. - - fatal: False - - default values: + default values: dict[select] - - '{}-{}'.format(common[sub_experiment_id], common[variant_label]) - - common[variant_label] - - forbidden patterns: 'none-.*' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + authorized values: + + - 'on_expt_and_year' + - 'on_expt' + - 'no' - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + select_excluded_opportunities - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - internal[CV_experiment][parent_activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + Excluded opportunities for variable selection. - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - internal[CV_experiment][parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + + + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + + + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: laboratory[sizes][internal[grid_choice]]format_sizes() + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: - default values: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + - '21.14100' + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + - internal[CV_experiment][activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: + fatal: False - - read_json_file('{}{}_source_id.json'.format(dict[cvspath], internal[project]))[source_id][internal[source_id]]make_source_string('source_id'= internal[source_id]) - - laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + default values: + + - laboratory[comment] + - '' - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + conventions_version + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.CMIP6_conventions_version + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' + + dr2xml_version + + Version of dr2xml used. + + fatal: False + + default values: dr2xml.config.version + + num type: 'string' + + experiment + + Name of the experiment. + + fatal: False + + default values: simulation[experiment] + + num type: 'string' + + expid_in_filename + + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: + + - laboratory[institution] + - read_json_file('{}{}_institution_id.json'.format(dict[cvspath], internal[project]))[institution_id][internal[institution_id]] + + num type: 'string' + + license + + File where the license associated with the produced output files can be found. + + fatal: False + + default values: read_json_file('{}{}_license.json'.format(dict[cvspath], internal[project]))[license][0] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + member_id + + Id of the member done. + + fatal: False + + default values: + + - '{}-{}'.format(common[sub_experiment_id], common[variant_label]) + - common[variant_label] + + forbidden patterns: 'none-.*' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + - internal[CV_experiment][parent_activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + - internal[CV_experiment][parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: + + - read_json_file('{}{}_source_id.json'.format(dict[cvspath], internal[project]))[source_id][internal[source_id]]make_source_string('source_id'= internal[source_id]) + - laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' + + variant_label + + Label of the variant done. + + fatal: False + + default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) + + num type: 'string' - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - - variant_label - - Label of the variant done. - - fatal: False - - default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) - - num type: 'string' - Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/CMIP7.rst b/sphinx/source/userguide/projects/CMIP7.rst index df3c38ff..d7292863 100644 --- a/sphinx/source/userguide/projects/CMIP7.rst +++ b/sphinx/source/userguide/projects/CMIP7.rst @@ -1,2543 +1,2545 @@ Parameters available for project CMIP7 ====================================== -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - CV_experiment - - Controlled vocabulary file containing experiment characteristics. - - fatal: False - - default values: read_json_file('{}{}_experiment_id.json'.format(dict[cvspath], internal[project]))[experiment_id][internal[experiment_id]] - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: internal[CV_experiment][additional_allowed_model_components] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + fatal: False - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + num type: 'string' - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + CV_experiment - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + Controlled vocabulary file containing experiment characteristics. - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + fatal: False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + default values: read_json_file('{}{}_experiment_id.json'.format(dict[cvspath], internal[project]))[experiment_id][internal[experiment_id]] - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + num type: 'string' - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + add_Gibraltar - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + fatal: False - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + num type: 'string' - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + additional_allowed_model_components - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + fatal: True - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + default values: internal[CV_experiment][additional_allowed_model_components] - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + allow_duplicates_in_same_table - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + fatal: True - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + allow_pseudo_standard_names - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + num type: 'string' - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + allow_tos_3hr_1deg - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + num type: 'string' - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + fatal: False - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + num type: 'string' - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + branching - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + fatal: False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + bypass_CV_components - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + fatal: False - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + bytes_per_float - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + fatal: False - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: internal[CV_experiment][required_model_components] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + num type: 'string' - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + configuration - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] - - Case: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[excluded_opportunities_lset] + fatal: True + + default values: simulation[configuration] + + num type: 'string' + + context + + Context associated with the xml file produced. + + fatal: True + + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[data_request_content_version] + - 'latest_stable' + + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - Case: + - laboratory[data_request_path] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - laboratory[data_request_used] + - 'CMIP6' + + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[debug_parsing] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - value: internal[excluded_request_links] + - laboratory[dr2xml_manages_enddate] + - True + + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - Case: + - simulation[end_year] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[excluded_opportunities] + - [] + + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_pairs] + - [] + + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[grid_choice] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: 'LR' + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: internal[included_opportunities] + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + included_vars_lset - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vargroups_lset] - - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + Variables to be considered from the Data Request (all others will not) from laboratory settings. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vars] - - Case: + fatal: False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vars_lset] + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[max_priority] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[max_priority_lset] - - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + institution_id - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[mips][internal[select_grid_choice]]sort_mips() - - Case: + Institution identifier. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[mips]sort_mips() + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + listof_home_vars + + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: - value: True + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None + + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - Case: + - laboratory[max_file_size_in_floats] + - 500000000.0 - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - value: False + - simulation[max_priority] + - internal[max_priority_lset] + + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - value: internal[year] + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False + + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - Case: + - laboratory[non_standard_attributes] + - {} - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - value: None + - laboratory[non_standard_axes] + - {} + + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[orography_field_name] + - 'orog' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - value: internal[sizes] + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None + + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - Case: + - laboratory[path_to_parse] + - './' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - value: None + - simulation[perso_sdims_description] + - {} + + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[print_stats_per_var_label] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - value: internal[tierMax] + - laboratory[print_variables] + - True + + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - Case: + - laboratory[project] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - value: internal[tierMax_lset] + - laboratory[project_settings] + - internal[project] + + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + - simulation[realization_index] + - '1' - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + realms_per_context - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + A dictionary which keys are context names and values the lists of realms associated with each context - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: laboratory[realms_per_context][internal[context]] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + num type: 'string' - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + required_model_components - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + Dictionary which gives, for each model name, the components that must be present. - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + fatal: True - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + default values: internal[CV_experiment][required_model_components] - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + sampling_timestep - - simulation[HDL] - - laboratory[HDL] - - '21.14100' - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - simulation[activity_id] - - laboratory[activity_id] - - internal[CV_experiment][activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + fatal: True - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + default values: laboratory[sampling_timestep] - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + num type: 'string' - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + save_project_settings - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'eq' - - reference values: internal[branching] - - Condition: - - check value: simulation[branch_year_in_parent] - - check to do: 'eq' - - reference values: internal[branching][internal[experiment_id]][1] - - - value: simulation[branch_year_in_parent] - - Case: + The path of the file where the complete project settings will be written, if needed. - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'neq' - - reference values: internal[branching] - - - value: simulation[branch_year_in_parent] + fatal: False + + default values: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + - laboratory[save_project_settings] + - None - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + sectors - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + List of the sectors to be considered. - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - conventions_version - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.CMIP6_conventions_version - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False - - default values: + fatal: False - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + default values: laboratory[sectors] - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + num type: 'string' - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + select - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + Selection strategy for variables. - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: + fatal: True - - laboratory[institution] - - read_json_file('{}{}_institution_id.json'.format(dict[cvspath], internal[project]))[institution_id][internal[institution_id]] - - num type: 'string' - - license - - File where the license associated with the produced output files can be found. - - fatal: False - - default values: read_json_file('{}{}_license.json'.format(dict[cvspath], internal[project]))[license][0] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - member_id - - Id of the member done. - - fatal: False - - default values: + default values: dict[select] - - '{}-{}'.format(common[sub_experiment_id], common[variant_label]) - - common[variant_label] - - forbidden patterns: 'none-.*' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + authorized values: + + - 'on_expt_and_year' + - 'on_expt' + - 'no' - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + select_excluded_opportunities - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - internal[CV_experiment][parent_activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + Excluded opportunities for variable selection. - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - internal[CV_experiment][parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + + + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + + + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: laboratory[sizes][internal[grid_choice]]format_sizes() + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: - default values: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + - '21.14100' + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + - internal[CV_experiment][activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: + fatal: False - - read_json_file('{}{}_source_id.json'.format(dict[cvspath], internal[project]))[source_id][internal[source_id]]make_source_string('source_id'= internal[source_id]) - - laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + default values: + + - laboratory[comment] + - '' - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + conventions_version + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.CMIP6_conventions_version + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' + + dr2xml_version + + Version of dr2xml used. + + fatal: False + + default values: dr2xml.config.version + + num type: 'string' + + experiment + + Name of the experiment. + + fatal: False + + default values: simulation[experiment] + + num type: 'string' + + expid_in_filename + + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: + + - laboratory[institution] + - read_json_file('{}{}_institution_id.json'.format(dict[cvspath], internal[project]))[institution_id][internal[institution_id]] + + num type: 'string' + + license + + File where the license associated with the produced output files can be found. + + fatal: False + + default values: read_json_file('{}{}_license.json'.format(dict[cvspath], internal[project]))[license][0] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + member_id + + Id of the member done. + + fatal: False + + default values: + + - '{}-{}'.format(common[sub_experiment_id], common[variant_label]) + - common[variant_label] + + forbidden patterns: 'none-.*' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + - internal[CV_experiment][parent_activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + - internal[CV_experiment][parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: + + - read_json_file('{}{}_source_id.json'.format(dict[cvspath], internal[project]))[source_id][internal[source_id]]make_source_string('source_id'= internal[source_id]) + - laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' + + variant_label + + Label of the variant done. + + fatal: False + + default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) + + num type: 'string' - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - - variant_label - - Label of the variant done. - - fatal: False - - default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) - - num type: 'string' - Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/CORDEX-CMIP6.rst b/sphinx/source/userguide/projects/CORDEX-CMIP6.rst index 51e9a94d..f9fd899b 100644 --- a/sphinx/source/userguide/projects/CORDEX-CMIP6.rst +++ b/sphinx/source/userguide/projects/CORDEX-CMIP6.rst @@ -1,2605 +1,2607 @@ Parameters available for project CORDEX-CMIP6 ============================================= -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + fatal: False - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + num type: 'string' - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + add_Gibraltar - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + fatal: False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + num type: 'string' - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + fatal: True - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + default values: [] - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + num type: 'string' - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + allow_duplicates - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + fatal: True - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + allow_pseudo_standard_names - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + fatal: False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + allow_tos_3hr_1deg - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + num type: 'string' - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + branch_year_in_child - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + num type: 'string' - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + branching - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + fatal: False - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + num type: 'string' - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + bypass_CV_components - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + fatal: False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + bytes_per_float - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + fatal: False - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + configuration - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + fatal: True - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + default values: simulation[configuration] - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + num type: 'string' - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + context - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + Context associated with the xml file produced. + + fatal: True + + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - Case: + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_content_version] + - 'latest_stable' + + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_path] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[data_request_used] + - 'CMIP6' + + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - Case: + - laboratory[debug_parsing] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - value: internal[excluded_pairs_lset] + - laboratory[dr2xml_manages_enddate] + - True + + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[end_year] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_request_links] + - laboratory[excluded_opportunities] + - [] + + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[excluded_pairs] + - [] + + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: internal[grid_choice] + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: 'LR' + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vars] + - [] + + num type: 'string' + + institution_id + + Institution identifier. + + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + listof_home_vars - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: - value: internal[included_vargroups_lset] + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None + + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[max_file_size_in_floats] + - 500000000.0 - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - value: internal[included_vars] + - simulation[max_priority] + - internal[max_priority_lset] + + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - Case: + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - value: internal[included_vars_lset] + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False + + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[non_standard_attributes] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - value: internal[max_priority] + - laboratory[non_standard_axes] + - {} + + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - Case: + - laboratory[orography_field_name] + - 'orog' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - value: internal[max_priority_lset] + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None + + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[path_to_parse] + - './' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - value: internal[mips][internal[select_grid_choice]]sort_mips() + - simulation[perso_sdims_description] + - {} + + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - Case: + - laboratory[print_stats_per_var_label] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - value: internal[mips]sort_mips() + - laboratory[print_variables] + - True + + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[project] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - value: True + - laboratory[project_settings] + - internal[project] + + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - Case: + - simulation[realization_index] + - '1' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: [] + + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: laboratory[sampling_timestep] + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - value: False + - laboratory[save_project_settings] + - None + + num type: 'string' + + sectors + + List of the sectors to be considered. + + fatal: False + + default values: laboratory[sectors] + + num type: 'string' + + select + + Selection strategy for variables. + + fatal: True + + default values: dict[select] + + authorized values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - 'on_expt_and_year' + - 'on_expt' + - 'no' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + select_excluded_opportunities + + Excluded opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[year] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: - Case: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + - conditions: - Condition: - - check value: internal[select] + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: + + conditions: + Condition: - reference values: - - - 'no' - - 'on_expt' - - - value: None - - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[sizes] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: None + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: True + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + select_included_tables - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + Included tables for variable selection. - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: [] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + num type: 'string' - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + select_included_vargroups - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + Included variables groups for variable selection. - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + fatal: True - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + default values: [] - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + - - simulation[HDL] - - laboratory[HDL] - - '21.14103' - - num type: 'string' - - Lambert_conformal_latitude_of_projection_origin - - TODO - - fatal: False - - default values: simulation[Lambert_conformal_latitude_of_projection_origin] - - num type: 'string' - - Lambert_conformal_longitude_of_central_meridian - - TODO - - fatal: False - - default values: simulation[Lambert_conformal_longitude_of_central_meridian] - - num type: 'string' - - Lambert_conformal_standard_parallel - - TODO - - fatal: False - - default values: simulation[Lambert_conformal_standard_parallel] - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + num type: 'string' - - simulation[activity_id] - - laboratory[activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + select_included_vars - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + Included variables for variable selection. - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + fatal: True - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + default values: [] - conditions: - Condition: - - check value: internal[experiment_id] + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - Condition: - - check value: simulation[branch_year_in_parent] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching][internal[experiment_id]][1] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: - Case: + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + - conditions: - Condition: - - check value: internal[experiment_id] + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: - check to do: 'neq' + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + simple_domain_grid_regexp - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - conventions_version - - TODO - - fatal: False - - default values: + fatal: False - - 'CF-1.11' - - laboratory[conventions_version] - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False - - default values: + default values: laboratory[simple_domain_grid_regexp] - - simulation[description] - - laboratory[description] - - num type: 'string' - - domain - - TODO - - fatal: False - - default values: simulation[domain][internal[context]] - - num type: 'string' - - domain_id - - TODO - - fatal: False - - default values: simulation[domain_id][internal[context]] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - driving_experiment - - TODO - - fatal: False - - default values: simulation[driving_experiment] - - num type: 'string' - - driving_experiment_id - - TODO - - fatal: False - - default values: simulation[driving_experiment_id] - - num type: 'string' - - driving_institution_id - - TODO - - fatal: False - - default values: simulation[driving_institution_id] - - num type: 'string' - - driving_source_id - - TODO - - fatal: False - - default values: simulation[driving_source_id] - - num type: 'string' - - driving_variant_label - - TODO - - fatal: False - - default values: simulation[driving_variant_label] - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + num type: 'string' - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + sizes - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + fatal: True - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: laboratory[institution] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + source_id - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + Name of the model used. - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False - - default values: + fatal: True - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + num type: 'string' - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + source_type - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - - version_realization - - TODO - - fatal: False - - default values: + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - simulation[version_realization] - - 'v1-r1' - - num type: 'string' + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + - '21.14103' + + num type: 'string' + + Lambert_conformal_latitude_of_projection_origin + + TODO + + fatal: False + + default values: simulation[Lambert_conformal_latitude_of_projection_origin] + + num type: 'string' + + Lambert_conformal_longitude_of_central_meridian + + TODO + + fatal: False + + default values: simulation[Lambert_conformal_longitude_of_central_meridian] + + num type: 'string' + + Lambert_conformal_standard_parallel + + TODO + + fatal: False + + default values: simulation[Lambert_conformal_standard_parallel] + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab + + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - laboratory[comment] + - '' + + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + conventions_version + + TODO + + fatal: False + + default values: + + - 'CF-1.11' + - laboratory[conventions_version] + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' + + domain + + TODO + + fatal: False + + default values: simulation[domain][internal[context]] + + num type: 'string' + + domain_id + + TODO + + fatal: False + + default values: simulation[domain_id][internal[context]] + + num type: 'string' + + dr2xml_version + + Version of dr2xml used. + + fatal: False + + default values: dr2xml.config.version + + num type: 'string' + + driving_experiment + + TODO + + fatal: False + + default values: simulation[driving_experiment] + + num type: 'string' + + driving_experiment_id + + TODO + + fatal: False + + default values: simulation[driving_experiment_id] + + num type: 'string' + + driving_institution_id + + TODO + + fatal: False + + default values: simulation[driving_institution_id] + + num type: 'string' + + driving_source_id + + TODO + + fatal: False + + default values: simulation[driving_source_id] + + num type: 'string' + + driving_variant_label + + TODO + + fatal: False + + default values: simulation[driving_variant_label] + + num type: 'string' + + experiment + + Name of the experiment. + + fatal: False + + default values: simulation[experiment] + + num type: 'string' + + expid_in_filename + + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: laboratory[institution] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' + + version_realization + + TODO + + fatal: False + + default values: + + - simulation[version_realization] + - 'v1-r1' + + num type: 'string' + Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/CORDEX.rst b/sphinx/source/userguide/projects/CORDEX.rst index 1abb3c0a..e6bea10e 100644 --- a/sphinx/source/userguide/projects/CORDEX.rst +++ b/sphinx/source/userguide/projects/CORDEX.rst @@ -1,2589 +1,2591 @@ Parameters available for project CORDEX ======================================= -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + fatal: False - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + num type: 'string' - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + add_Gibraltar - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + fatal: False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + num type: 'string' - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + fatal: True - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + default values: [] - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + num type: 'string' - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + allow_duplicates - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + fatal: True - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + allow_pseudo_standard_names - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + fatal: False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + allow_tos_3hr_1deg - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + num type: 'string' - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + branch_year_in_child - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + fatal: False - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + num type: 'string' - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + branching - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + fatal: False - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + num type: 'string' - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + bypass_CV_components - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + fatal: False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + bytes_per_float - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + fatal: False - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + configuration - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + fatal: True - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + default values: simulation[configuration] - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + num type: 'string' - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + context - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + Context associated with the xml file produced. + + fatal: True + + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - Case: + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_content_version] + - 'latest_stable' + + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_path] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[data_request_used] + - 'CMIP6' + + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - Case: + - laboratory[debug_parsing] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - value: internal[excluded_pairs_lset] + - laboratory[dr2xml_manages_enddate] + - True + + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[end_year] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_request_links] + - laboratory[excluded_opportunities] + - [] + + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[excluded_pairs] + - [] + + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: internal[grid_choice] + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: 'LR' + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vars] + - [] + + num type: 'string' + + institution_id + + Institution identifier. + + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + listof_home_vars - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: - value: internal[included_vargroups_lset] + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None + + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[max_file_size_in_floats] + - 500000000.0 - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - value: internal[included_vars] + - simulation[max_priority] + - internal[max_priority_lset] + + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - Case: + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - value: internal[included_vars_lset] + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False + + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[non_standard_attributes] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - value: internal[max_priority] + - laboratory[non_standard_axes] + - {} + + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - Case: + - laboratory[orography_field_name] + - 'orog' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - value: internal[max_priority_lset] + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None + + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[path_to_parse] + - './' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - value: internal[mips][internal[select_grid_choice]]sort_mips() + - simulation[perso_sdims_description] + - {} + + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - Case: + - laboratory[print_stats_per_var_label] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - value: internal[mips]sort_mips() + - laboratory[print_variables] + - True + + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[project] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - value: True + - laboratory[project_settings] + - internal[project] + + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - Case: + - simulation[realization_index] + - '1' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: [] + + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: laboratory[sampling_timestep] + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - value: False + - laboratory[save_project_settings] + - None + + num type: 'string' + + sectors + + List of the sectors to be considered. + + fatal: False + + default values: laboratory[sectors] + + num type: 'string' + + select + + Selection strategy for variables. + + fatal: True + + default values: dict[select] + + authorized values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - 'on_expt_and_year' + - 'on_expt' + - 'no' - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + select_excluded_opportunities + + Excluded opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[year] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: - Case: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + - conditions: - Condition: - - check value: internal[select] + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: + + conditions: + Condition: - reference values: - - - 'no' - - 'on_expt' - - - value: None - - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[sizes] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: None + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: True + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + select_included_tables - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + Included tables for variable selection. - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: [] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + num type: 'string' - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + select_included_vargroups - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + Included variables groups for variable selection. - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + fatal: True - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + default values: [] - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - CORDEX_domain - - Dictionary which contains, for each context, the associated CORDEX domain. - - fatal: False - - default values: simulation[CORDEX_domain][internal[context]] - - num type: 'string' - - HDL - - HDL associated with the project. - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + - - simulation[HDL] - - laboratory[HDL] - - '21.14103' - - num type: 'string' - - Lambert_conformal_latitude_of_projection_origin - - Latitude of central meridian of the Lambert conformal projection. - - fatal: False - - default values: simulation[Lambert_conformal_latitude_of_projection_origin] - - num type: 'string' - - Lambert_conformal_longitude_of_central_meridian - - Longitude of central meridian of the Lambert conformal projection. - - fatal: False - - default values: simulation[Lambert_conformal_longitude_of_central_meridian] - - num type: 'string' - - Lambert_conformal_standard_parallel - - Standard parallel of the Lambert conformal projection. - - fatal: False - - default values: simulation[Lambert_conformal_standard_parallel] - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + num type: 'string' - - simulation[activity_id] - - laboratory[activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + select_included_vars - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + Included variables for variable selection. - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + fatal: True - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + default values: [] - conditions: - Condition: - - check value: internal[experiment_id] + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - Condition: - - check value: simulation[branch_year_in_parent] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching][internal[experiment_id]][1] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: - Case: - - conditions: - Condition: - - check value: internal[experiment_id] + conditions: + Condition: - check to do: 'neq' + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching] + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + select_tierMax - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + tierMax for variable selection. - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - conventions_version - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.CMIP6_conventions_version - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False - - default values: + fatal: True - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - driving_experiment - - Id of the experiment which drives the current simulation. - - fatal: False - - default values: simulation[driving_experiment] - - num type: 'string' - - driving_experiment_name - - Name of the experiment which drives the current simulation. - - fatal: False - - default values: simulation[driving_experiment_name] - - num type: 'string' - - driving_model_ensemble_member - - Member of the simulation which drives the simulation. - - fatal: False - - default values: simulation[driving_model_ensemble_member] - - num type: 'string' - - driving_model_id - - Id of the driving model. - - fatal: False - - default values: simulation[driving_model_id] - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + default values: [] - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + num type: 'string' - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + simple_domain_grid_regexp - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: laboratory[institution] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + fatal: False - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + default values: laboratory[simple_domain_grid_regexp] - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + num type: 'string' - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False - - default values: + sizes - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - rcm_version_id - - Version id of the regional model used. - - fatal: False - - default values: simulation[rcm_version_id] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + fatal: True - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - - variant_label - - Label of the variant done. - - fatal: False - - default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) - - num type: 'string' + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: + CORDEX_domain + + Dictionary which contains, for each context, the associated CORDEX domain. + + fatal: False + + default values: simulation[CORDEX_domain][internal[context]] + + num type: 'string' + + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + - '21.14103' + + num type: 'string' + + Lambert_conformal_latitude_of_projection_origin + + Latitude of central meridian of the Lambert conformal projection. + + fatal: False + + default values: simulation[Lambert_conformal_latitude_of_projection_origin] + + num type: 'string' + + Lambert_conformal_longitude_of_central_meridian + + Longitude of central meridian of the Lambert conformal projection. + + fatal: False + + default values: simulation[Lambert_conformal_longitude_of_central_meridian] + + num type: 'string' + + Lambert_conformal_standard_parallel + + Standard parallel of the Lambert conformal projection. + + fatal: False + + default values: simulation[Lambert_conformal_standard_parallel] + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab + + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - laboratory[comment] + - '' + + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + conventions_version + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.CMIP6_conventions_version + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' + + dr2xml_version + + Version of dr2xml used. + + fatal: False + + default values: dr2xml.config.version + + num type: 'string' + + driving_experiment + + Id of the experiment which drives the current simulation. + + fatal: False + + default values: simulation[driving_experiment] + + num type: 'string' + + driving_experiment_name + + Name of the experiment which drives the current simulation. + + fatal: False + + default values: simulation[driving_experiment_name] + + num type: 'string' + + driving_model_ensemble_member + + Member of the simulation which drives the simulation. + + fatal: False + + default values: simulation[driving_model_ensemble_member] + + num type: 'string' + + driving_model_id + + Id of the driving model. + + fatal: False + + default values: simulation[driving_model_id] + + num type: 'string' + + experiment + + Name of the experiment. + + fatal: False + + default values: simulation[experiment] + + num type: 'string' + + expid_in_filename + + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: laboratory[institution] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + rcm_version_id + + Version id of the regional model used. + + fatal: False + + default values: simulation[rcm_version_id] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' + + variant_label + + Label of the variant done. + + fatal: False + + default values: 'r{}i{}p{}f{}'.format(internal[realization_index], common[initialization_index], common[physics_index], common[forcing_index]) + + num type: 'string' + Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/basics.rst b/sphinx/source/userguide/projects/basics.rst index 72b0ef29..4afe8290 100644 --- a/sphinx/source/userguide/projects/basics.rst +++ b/sphinx/source/userguide/projects/basics.rst @@ -1,2484 +1,2486 @@ Parameters available for project basics ======================================= -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: + fatal: False - - laboratory[additional_allowed_model_components][internal[source_id]] - - [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + num type: 'string' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + add_Gibraltar - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + fatal: False - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + num type: 'string' - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + fatal: True - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + default values: + + - laboratory[additional_allowed_model_components][internal[source_id]] + - [] - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + num type: 'string' - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + fatal: False - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + fatal: True - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + allow_pseudo_standard_names - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + fatal: False - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + allow_tos_3hr_1deg - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + fatal: False - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + branching - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + fatal: False - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + num type: 'string' - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + bypass_CV_components - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + fatal: False - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + num type: 'string' - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + bytes_per_float - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + fatal: False - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + configuration - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + fatal: True - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + default values: simulation[configuration] - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: + num type: 'string' - - laboratory[required_model_components][internal[source_id]] - - [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + context - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + Context associated with the xml file produced. - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + fatal: True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' + + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - Case: + - laboratory[data_request_content_version] + - 'latest_stable' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_path] + - None + + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_used] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[debug_parsing] + - False + + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - Case: + - laboratory[dr2xml_manages_enddate] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - simulation[end_year] + - False + + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - value: internal[excluded_request_links] + - simulation[excluded_opportunities] + - [] + + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: None + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: internal[grid_choice] + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: 'LR' + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities] + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_tables] + - internal[included_tables_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_vargroups] + - internal[included_vargroups_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: None + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[included_vars] + - internal[included_vars_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[included_vars] + - [] + + num type: 'string' + + institution_id + + Institution identifier. + + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - Case: + - laboratory[laboratory_used] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + listof_home_vars - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vargroups_lset] - - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vars] + fatal: False + + default values: - Case: + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - value: internal[included_vars_lset] + - laboratory[max_file_size_in_floats] + - 500000000.0 + + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[max_priority] + - internal[max_priority_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - value: internal[max_priority] + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None + + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - Case: + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - value: internal[max_priority_lset] + - laboratory[non_standard_attributes] + - {} + + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[non_standard_axes] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - value: internal[mips][internal[select_grid_choice]]sort_mips() + - laboratory[orography_field_name] + - 'orog' + + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - Case: + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - value: internal[mips]sort_mips() + - laboratory[path_to_parse] + - './' + + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - simulation[perso_sdims_description] + - {} - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - value: True + - laboratory[print_stats_per_var_label] + - False + + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - Case: + - laboratory[print_variables] + - True - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - value: False + - laboratory[project] + - 'CMIP6' + + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[project_settings] + - internal[project] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - value: internal[year] + - simulation[realization_index] + - '1' + + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: - Case: + - laboratory[required_model_components][internal[source_id]] + - [] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: laboratory[sampling_timestep] + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - value: None + - laboratory[save_project_settings] + - None + + num type: 'string' + + sectors + + List of the sectors to be considered. + + fatal: False + + default values: laboratory[sectors] + + num type: 'string' + + select + + Selection strategy for variables. + + fatal: True + + default values: dict[select] + + authorized values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - 'on_expt_and_year' + - 'on_expt' + - 'no' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + select_excluded_opportunities + + Excluded opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[sizes] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' - - reference values: False - - - value: None - - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[tierMax] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[tierMax_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + select_excluded_request_links - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + Excluded request links for variable selection. - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: [] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + num type: 'string' - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + select_excluded_tables - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + Excluded tables for variable selection. - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + fatal: True - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + default values: [] - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + - - simulation[HDL] - - laboratory[HDL] - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + num type: 'string' - - simulation[activity_id] - - laboratory[activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + select_excluded_vargroups - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + Excluded variables groups for variable selection. - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + fatal: True - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + default values: [] - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'eq' - - reference values: internal[branching] - - Condition: - - check value: simulation[branch_year_in_parent] - - check to do: 'eq' - - reference values: internal[branching][internal[experiment_id]][1] - + cases: + Case: - value: simulation[branch_year_in_parent] - - Case: - - conditions: - Condition: - - check value: internal[experiment_id] + conditions: + Condition: - check to do: 'neq' - - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + select_grid_choice - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + Grid choice for variable selection. - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: laboratory[sizes][internal[grid_choice]]format_sizes() + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: + + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: - default values: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab + + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - laboratory[comment] + - '' + + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + dr2xml_version - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + Version of dr2xml used. - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + fatal: False - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + default values: dr2xml.config.version - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: laboratory[institution] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + num type: 'string' - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + experiment - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + Name of the experiment. - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + fatal: False - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False - - default values: + default values: simulation[experiment] - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + num type: 'string' - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + expid_in_filename - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: laboratory[institution] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/dr2xml.rst b/sphinx/source/userguide/projects/dr2xml.rst index 7342d52a..3a4dc3a7 100644 --- a/sphinx/source/userguide/projects/dr2xml.rst +++ b/sphinx/source/userguide/projects/dr2xml.rst @@ -1,1999 +1,2001 @@ Parameters available for project dr2xml ======================================= -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: + fatal: False - - laboratory[additional_allowed_model_components][internal[source_id]] - - [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + num type: 'string' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + add_Gibraltar - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + fatal: False - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + num type: 'string' - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: simulation[configuration] - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + fatal: True - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + default values: + + - laboratory[additional_allowed_model_components][internal[source_id]] + - [] - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + num type: 'string' - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + fatal: False - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + fatal: True - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + allow_pseudo_standard_names - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[experiment_for_requests] - - internal[experiment_id] - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: simulation[experiment_id] - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + fatal: False - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: laboratory[grid_choice][internal[source_id]] - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: + num type: 'string' - - laboratory[grid_policy] - - False - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + allow_tos_3hr_1deg - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: laboratory[grids] - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + fatal: False - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + branching - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + fatal: False - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + num type: 'string' - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + bypass_CV_components - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + fatal: False - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + num type: 'string' - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + bytes_per_float - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: laboratory[orphan_variables] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + fatal: False - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + num type: 'string' - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + configuration - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + fatal: True - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + default values: simulation[configuration] - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: + num type: 'string' - - laboratory[required_model_components][internal[source_id]] - - [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: laboratory[sampling_timestep] - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + context - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + Context associated with the xml file produced. - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + fatal: True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' + + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - Case: + - laboratory[data_request_content_version] + - 'latest_stable' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_path] + - None + + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_used] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[debug_parsing] + - False + + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - Case: + - laboratory[dr2xml_manages_enddate] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - simulation[end_year] + - False + + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: + + - simulation[excluded_opportunities] + - [] + + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_request_links] + - laboratory[excluded_pairs] + - [] + + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - value: None + - laboratory[excluded_request_links] + - [] + + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_spshapes] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - laboratory[excluded_tables] + - [] + + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - Case: + - simulation[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - laboratory[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_vars] + - [] + + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - Case: + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - simulation[excluded_vars] + - [] + + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[experiment_for_requests] + - internal[experiment_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: simulation[experiment_id] + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: laboratory[grid_choice][internal[source_id]] + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: - value: internal[excluded_vars_lset] + - laboratory[grid_policy] + - False + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[grid_prefix] + - internal[ping_variables_prefix] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: laboratory[grids] + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - value: internal[grid_choice] + - laboratory[grids_dev] + - {} + + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - Case: + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - value: 'LR' + - simulation[included_opportunities] + - internal[included_opportunities_lset] + + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_opportunities] + - [] + + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: + + - laboratory[included_request_links] + - [] + + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: + + - simulation[included_tables] + - internal[included_tables_lset] + + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: + + - laboratory[included_tables] + - [] + + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: + + - simulation[included_vargroups] + - internal[included_vargroups_lset] + + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: + + - laboratory[included_vargroups] + - [] + + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: + + - simulation[included_vars] + - internal[included_vars_lset] + + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: + + - laboratory[included_vars] + - [] + + num type: 'string' + + institution_id + + Institution identifier. + + fatal: True + + default values: laboratory[institution_id] + + num type: 'string' + + laboratory_used + + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: + + - laboratory[laboratory_used] + - None + + num type: 'string' + + listof_home_vars + + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: + + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None + + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: + + - laboratory[max_file_size_in_floats] + - 500000000.0 + + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: + + - simulation[max_priority] + - internal[max_priority_lset] + + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: + + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None + + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_opportunities] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_opportunities_lset] + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - value: internal[included_request_links] + - laboratory[non_standard_attributes] + - {} + + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - Case: + - laboratory[non_standard_axes] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - value: None + - laboratory[orography_field_name] + - 'orog' + + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: laboratory[orphan_variables] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - value: internal[included_tables] + - laboratory[path_to_parse] + - './' + + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - Case: + - simulation[perso_sdims_description] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - value: internal[included_tables_lset] + - laboratory[print_stats_per_var_label] + - False + + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[print_variables] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - value: internal[included_vargroups] + - laboratory[project] + - 'CMIP6' + + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - Case: + - laboratory[project_settings] + - internal[project] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - value: internal[included_vargroups_lset] + - simulation[realization_index] + - '1' + + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[required_model_components][internal[source_id]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: laboratory[sampling_timestep] + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - value: internal[included_vars] + - laboratory[save_project_settings] + - None + + num type: 'string' + + sectors + + List of the sectors to be considered. + + fatal: False + + default values: laboratory[sectors] + + num type: 'string' + + select + + Selection strategy for variables. + + fatal: True + + default values: dict[select] + + authorized values: - Case: + - 'on_expt_and_year' + - 'on_expt' + - 'no' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' + num type: 'string' + + select_excluded_opportunities + + Excluded opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + + + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[included_vars_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + + + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: True + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[max_priority] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + + + num type: 'string' + + select_excluded_vars + + Excluded variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[max_priority_lset] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: True + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[mips][internal[select_grid_choice]]sort_mips() + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: - Case: - - conditions: - Condition: - - check value: internal[select_on_expt] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: False + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: internal[mips]sort_mips() + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: - - conditions: - Condition: - - check value: internal[select] + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: - - - 'on_expt_and_year' - - 'on_expt' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: True + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: - Case: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. - conditions: - Condition: - - check value: internal[select] + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: 'no' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: - value: False - - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes - conditions: - Condition: - - check value: internal[select] + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: - reference values: 'on_expt_and_year' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: - value: internal[year] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: laboratory[sizes][internal[grid_choice]]format_sizes() + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: - Case: + - laboratory[configurations][internal[configuration]][0] + - simulation[source_id] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: - value: None + - laboratory[configurations][internal[configuration]][1] + - simulation[source_type] + - laboratory[source_types][internal[source_id]] + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[special_timestep_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: - value: internal[sizes] + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: - Case: + - simulation[tierMax] + - internal[tierMax_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: - value: None + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[useAtForInstant] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: - value: internal[tierMax] + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: - Case: + - laboratory[use_union_zoom] + - False - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: - value: internal[tierMax_lset] + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: laboratory[sizes][internal[grid_choice]]format_sizes() - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: + - laboratory[xios_version] + - 2 - - laboratory[configurations][internal[configuration]][0] - - simulation[source_id] - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: + num type: 'string' - - laboratory[configurations][internal[configuration]][1] - - simulation[source_type] - - laboratory[source_types][internal[source_id]] - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + year - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + Year associated with the launch of dr2xml. - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + fatal: True - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + default values: dict[year] - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + num type: 'string' - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + zg_field_name - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + Name of the geopotential height field name to be used to compute height over orog fields. - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + fatal: False - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + default values: + + - laboratory[zg_field_name] + - 'zg' - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + num type: 'string' - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + Project settings ---------------- .. glossary:: diff --git a/sphinx/source/userguide/projects/ping.rst b/sphinx/source/userguide/projects/ping.rst index ab98c0ac..4f4d8073 100644 --- a/sphinx/source/userguide/projects/ping.rst +++ b/sphinx/source/userguide/projects/ping.rst @@ -1,2481 +1,2483 @@ Parameters available for project ping ===================================== -Internal values ---------------- -.. glossary:: - :sorted: - - CFsubhr_frequency - - CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. +Unsorted parameters +------------------- + Internal values + ^^^^^^^^^^^^^^^ + .. glossary:: + :sorted: - fatal: False - - default values: + CFsubhr_frequency - - laboratory[CFsubhr_frequency] - - '1ts' - - num type: 'string' - - add_Gibraltar - - DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - fatal: False - - default values: + CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step. - - laboratory[add_Gibraltar] - - False - - num type: 'string' - - additional_allowed_model_components - - Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - fatal: True - - default values: + fatal: False - - laboratory[additional_allowed_model_components][internal[source_id]] - - [] - - num type: 'string' - - adhoc_policy_do_add_1deg_grid_for_tos - - Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - fatal: False - - default values: + default values: + + - laboratory[CFsubhr_frequency] + - '1ts' - - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] - - False - - num type: 'string' - - allow_duplicates - - Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - fatal: False - - default values: + num type: 'string' - - laboratory[allow_duplicates] - - True - - num type: 'string' - - allow_duplicates_in_same_table - - Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - fatal: True - - default values: + add_Gibraltar - - laboratory[allow_duplicates_in_same_table] - - False - - num type: 'string' - - allow_pseudo_standard_names - - DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - fatal: False - - default values: + DR01.00.21 does not include Gibraltar strait, which is requested by OMIP. Can include it, if model provides it as last value of array. - - laboratory[allow_pseudo_standard_names] - - False - - num type: 'string' - - allow_tos_3hr_1deg - - When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - fatal: False - - default values: + fatal: False - - laboratory[allow_tos_3hr_1deg] - - True - - num type: 'string' - - branch_year_in_child - - In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - fatal: False - - default values: simulation[branch_year_in_child] - - num type: 'string' - - branching - - Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - fatal: False - - default values: + default values: + + - laboratory[add_Gibraltar] + - False - - laboratory[branching][internal[source_id]] - - {} - - num type: 'string' - - bypass_CV_components - - If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - fatal: False - - default values: + num type: 'string' - - laboratory[bypass_CV_components] - - False - - num type: 'string' - - bytes_per_float - - Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - fatal: False - - default values: + additional_allowed_model_components - - laboratory[bytes_per_float] - - 2 - - num type: 'string' - - configuration - - Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - fatal: True - - default values: None - - num type: 'string' - - context - - Context associated with the xml file produced. - - fatal: True - - default values: dict[context] - - num type: 'string' - - data_request_config - - Configuration file of the data request content to be used - - fatal: False - - default values: + Dictionary which contains, for each model, the list of components whih can be used in addition to the declared ones. - - laboratory[data_request_config] - - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' - - num type: 'string' - - data_request_content_version - - Version of the data request content to be used - - fatal: False - - default values: + fatal: True - - laboratory[data_request_content_version] - - 'latest_stable' - - num type: 'string' - - data_request_path - - Path where the data request API used is placed. - - fatal: False - - default values: + default values: + + - laboratory[additional_allowed_model_components][internal[source_id]] + - [] - - laboratory[data_request_path] - - None - - num type: 'string' - - data_request_used - - The Data Request infrastructure type which should be used. - - fatal: False - - default values: + num type: 'string' - - laboratory[data_request_used] - - 'CMIP6' - - num type: 'string' - - debug_parsing - - In order to identify which xml files generates a problem, you can use this flag. - - fatal: False - - default values: + adhoc_policy_do_add_1deg_grid_for_tos - - laboratory[debug_parsing] - - False - - num type: 'string' - - dr2xml_manages_enddate - - A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. - - fatal: True - - default values: + Some scenario experiment in DR 01.00.21 do not request tos on 1 degree grid, while other do. If you use grid_policy=adhoc and had not changed the mapping of function. grids.lab_adhoc_grid_policy to grids.CNRM_grid_policy, next setting can force any tos request to also produce tos on a 1 degree grid. - - laboratory[dr2xml_manages_enddate] - - True - - num type: 'string' - - end_year - - If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value - - fatal: False - - default values: + fatal: False - - simulation[end_year] - - False - - num type: 'string' - - excluded_opportunities_lset - - List of the opportunities that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[adhoc_policy_do_add_1deg_grid_for_tos] + - False - - laboratory[excluded_opportunities] - - [] - - num type: 'string' - - excluded_opportunities_sset - - List of the opportunities that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + num type: 'string' - - simulation[excluded_opportunities] - - [] - - num type: 'string' - - excluded_pairs_lset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. - - fatal: False - - default values: + allow_duplicates - - laboratory[excluded_pairs] - - [] - - num type: 'string' - - excluded_pairs_sset - - You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. - - fatal: False - - default values: + Should we allow for duplicate vars: two vars with same frequency, shape and realm, which differ only by the table. In DR01.00.21, this actually applies to very few fields (ps-Aermon, tas-ImonAnt, areacellg-IfxAnt). - - simulation[excluded_pairs] - - [] - - num type: 'string' - - excluded_request_links - - List of links un data request that should not been followed (those request are not taken into account). - - fatal: False - - default values: + fatal: False - - laboratory[excluded_request_links] - - [] - - num type: 'string' - - excluded_spshapes_lset - - The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates] + - True - - laboratory[excluded_spshapes] - - [] - - num type: 'string' - - excluded_tables_lset - - List of the tables that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_tables] - - [] - - num type: 'string' - - excluded_tables_sset - - List of the tables that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + allow_duplicates_in_same_table - - simulation[excluded_tables] - - [] - - num type: 'string' - - excluded_vargroups_lset - - List of the variables groups that will be excluded from outputs from laboratory settings. - - fatal: False - - default values: + Should we allow for another type of duplicate vars : two vars with same name in same table (usually with different shapes). This applies to e.g. CMOR vars 'ua' and 'ua7h' in 6hPlevPt. Default to False, because CMIP6 rules does not allow to name output files differently in that case. If set to True, you should also set 'use_cmorvar_label_in_filename' to True to overcome the said rule. - - laboratory[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vargroups_sset - - List of the variables groups that will be excluded from outputs from simulation settings. - - fatal: False - - default values: + fatal: True - - simulation[excluded_vargroups] - - [] - - num type: 'string' - - excluded_vars_lset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. - - fatal: False - - default values: + default values: + + - laboratory[allow_duplicates_in_same_table] + - False - - laboratory[excluded_vars] - - [] - - num type: 'string' - - excluded_vars_per_config - - A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. - - fatal: False - - default values: + num type: 'string' - - laboratory[excluded_vars_per_config][internal[configuration]] - - [] - - num type: 'string' - - excluded_vars_sset - - List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. - - fatal: False - - default values: + allow_pseudo_standard_names - - simulation[excluded_vars] - - [] - - num type: 'string' - - experiment_for_requests - - Experiment id to use for driving the use of the Data Request. - - fatal: True - - default values: None - - num type: 'string' - - experiment_id - - Root experiment identifier. - - fatal: True - - default values: None - - num type: 'string' - - filter_on_realization - - If you want to produce the same variables set for all members, set this parameter to False. - - fatal: False - - default values: + DR has sn attributes for MIP variables. They can be real,CF-compliant, standard_names or pseudo_standard_names, i.e. not yet approved labels. Default is to use only CF ones. - - simulation[filter_on_realization] - - laboratory[filter_on_realization] - - True - - num type: 'string' - - fx_from_file - - You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. - - fatal: False - - default values: + fatal: False - - laboratory[fx_from_file] - - [] - - num type: 'string' - - grid_choice - - A dictionary which keys are models name and values the corresponding resolution. - - fatal: True - - default values: None - - num type: 'string' - - grid_policy - - The grid choice policy for output files. - - fatal: True - - default values: None - - num type: 'string' - - grid_prefix - - Prefix of the dr2xml generated grid named to be used. - - fatal: True - - default values: + default values: + + - laboratory[allow_pseudo_standard_names] + - False - - laboratory[grid_prefix] - - internal[ping_variables_prefix] - - num type: 'string' - - grids - - Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description - - fatal: True - - default values: None - - num type: 'string' - - grids_dev - - Grids definition for dev variables. - - fatal: True - - default values: + num type: 'string' - - laboratory[grids_dev] - - {} - - num type: 'string' - - grouped_vars_per_file - - Variables to be grouped in the same output file (provided additional conditions are filled). - - fatal: False - - default values: + allow_tos_3hr_1deg - - simulation[grouped_vars_per_file] - - laboratory[grouped_vars_per_file] - - [] - - num type: 'string' - - included_opportunities - - List of opportunities that will be processed (all others will not). - - fatal: False - - default values: + When using select='no', Xios may enter an endless loop, which is solved if next setting is False. - - simulation[included_opportunities] - - internal[included_opportunities_lset] - - num type: 'string' - - included_opportunities_lset - - List of opportunities that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[included_opportunities] - - [] - - num type: 'string' - - included_request_links - - List of the request links that will be processed (all others will not). - - fatal: False - - default values: + default values: + + - laboratory[allow_tos_3hr_1deg] + - True - - laboratory[included_request_links] - - [] - - num type: 'string' - - included_tables - - List of tables that will be processed (all others will not). - - fatal: False - - default values: + num type: 'string' - - simulation[included_tables] - - internal[included_tables_lset] - - num type: 'string' - - included_tables_lset - - List of tables that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + branch_year_in_child - - laboratory[included_tables] - - [] - - num type: 'string' - - included_vargroups - - List of variables groups that will be processed (all others will not). - - fatal: False - - default values: + In some instances, the experiment start year is not explicit or is doubtful in DR. See file doc/some_experiments_starty_in_DR01.00.21. You should then specify it, using next setting in order that requestItems analysis work in all cases. In some other cases, DR requestItems which apply to the experiment form its start does not cover its whole duration and have a wrong duration (computed based on a wrong start year); They necessitate to fix the start year. - - simulation[included_vargroups] - - internal[included_vargroups_lset] - - num type: 'string' - - included_vargroups_lset - - List of variables groups that will be processed (all others will not) from laboratory settings. - - fatal: False - - default values: + fatal: False - - laboratory[included_vargroups] - - [] - - num type: 'string' - - included_vars - - Variables to be considered from the Data Request (all others will not) - - fatal: False - - default values: + default values: simulation[branch_year_in_child] - - simulation[included_vars] - - internal[included_vars_lset] - - num type: 'string' - - included_vars_lset - - Variables to be considered from the Data Request (all others will not) from laboratory settings. - - fatal: False - - default values: + num type: 'string' - - laboratory[included_vars] - - [] - - num type: 'string' - - institution_id - - Institution identifier. - - fatal: True - - default values: laboratory[institution_id] - - num type: 'string' - - laboratory_used - - File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. - - fatal: False - - default values: + branching - - laboratory[laboratory_used] - - None - - num type: 'string' - - listof_home_vars - - Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. - - fatal: False - - default values: + Describe the branching scheme for experiments involved in some 'branchedYears type' tslice (for details, see: http://clipc-services.ceda.ac.uk/dreq/index/Slice.html ). Just put the as key the common start year in child and as value the list of start years in parent for all members.A dictionary with models name as key and dictionary containing experiment,(branch year in child, list of branch year in parent) key values. - - simulation[listof_home_vars] - - laboratory[listof_home_vars] - - None - - num type: 'string' - - max_file_size_in_floats - - The maximum size of generated files in number of floating values. - - fatal: False - - default values: + fatal: False - - laboratory[max_file_size_in_floats] - - 500000000.0 - - num type: 'string' - - max_priority - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). - - fatal: True - - default values: + default values: + + - laboratory[branching][internal[source_id]] + - {} - - simulation[max_priority] - - internal[max_priority_lset] - - num type: 'string' - - max_priority_lset - - Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. - - fatal: True - - default values: laboratory[max_priority] - - num type: 'string' - - max_split_freq - - The maximum number of years that should be putted in a single file. - - fatal: True - - default values: + num type: 'string' - - simulation[max_split_freq] - - laboratory[max_split_freq] - - None - - num type: 'string' - - mips - - A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. - - fatal: True - - default values: laboratory[mips] - - num type: 'string' - - nemo_sources_management_policy_master_of_the_world - - Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. - - fatal: True - - default values: + bypass_CV_components - - laboratory[nemo_sources_management_policy_master_of_the_world] - - False - - num type: 'string' - - non_standard_attributes - - You may add a series of NetCDF attributes in all files for this simulation - - fatal: False - - default values: + If the CMIP6 Controlled Vocabulary doesn't allow all the components you activate, you can set next toggle to True - - laboratory[non_standard_attributes] - - {} - - num type: 'string' - - non_standard_axes - - If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. - - fatal: False - - default values: + fatal: False - - laboratory[non_standard_axes] - - {} - - num type: 'string' - - orography_field_name - - Name of the orography field name to be used to compute height over orog fields. - - fatal: False - - default values: + default values: + + - laboratory[bypass_CV_components] + - False - - laboratory[orography_field_name] - - 'orog' - - num type: 'string' - - orphan_variables - - A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) - - fatal: True - - default values: [] - - num type: 'string' - - path_extra_tables - - Full path of the directory which contains extra tables. - - fatal: False - - default values: + num type: 'string' - - simulation[path_extra_tables] - - laboratory[path_extra_tables] - - None - - num type: 'string' - - path_special_defs - - TODO - - fatal: False - - default values: laboratory[path_special_defs] - - num type: 'string' - - path_to_parse - - The path of the directory which, at run time, contains the root XML file (iodef.xml). - - fatal: False - - default values: + bytes_per_float - - laboratory[path_to_parse] - - './' - - num type: 'string' - - perso_sdims_description - - A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. - - fatal: False - - default values: + Estimate of number of bytes per floating value, given the chosen :term:`compression_level`. - - simulation[perso_sdims_description] - - {} - - num type: 'string' - - ping_variables_prefix - - The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. - - fatal: True - - default values: laboratory[ping_variables_prefix] - - num type: 'string' - - prefixed_orography_field_name - - Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. - - fatal: False - - default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) - - num type: 'string' - - print_stats_per_var_label - - For an extended printout of selected CMOR variables, grouped by variable label. - - fatal: False - - default values: + fatal: False - - laboratory[print_stats_per_var_label] - - False - - num type: 'string' - - print_variables - - If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. - - fatal: False - - default values: + default values: + + - laboratory[bytes_per_float] + - 2 - - laboratory[print_variables] - - True - - num type: 'string' - - project - - Project associated with the simulation. - - fatal: False - - default values: + num type: 'string' - - laboratory[project] - - 'CMIP6' - - num type: 'string' - - project_settings - - Project settings definition file to be used. - - fatal: False - - default values: + configuration - - laboratory[project_settings] - - internal[project] - - num type: 'string' - - realization_index - - Realization number. - - fatal: False - - default values: + Configuration used for this experiment. If there is no configuration in lab_settings which matches you case, please rather use next or next two entries: :term:`source_id` and, if needed, :term:`source_type`. - - simulation[realization_index] - - '1' - - num type: 'string' - - realms_per_context - - A dictionary which keys are context names and values the lists of realms associated with each context - - fatal: True - - default values: laboratory[realms_per_context][internal[context]] - - num type: 'string' - - required_model_components - - Dictionary which gives, for each model name, the components that must be present. - - fatal: True - - default values: + fatal: True - - laboratory[required_model_components][internal[source_id]] - - [] - - num type: 'string' - - sampling_timestep - - Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. - - fatal: True - - default values: None - - num type: 'string' - - save_project_settings - - The path of the file where the complete project settings will be written, if needed. - - fatal: False - - default values: + default values: None - - laboratory[save_project_settings] - - None - - num type: 'string' - - sectors - - List of the sectors to be considered. - - fatal: False - - default values: laboratory[sectors] - - num type: 'string' - - select - - Selection strategy for variables. - - fatal: True - - default values: dict[select] - - authorized values: + num type: 'string' - - 'on_expt_and_year' - - 'on_expt' - - 'no' - - num type: 'string' - - select_excluded_opportunities - - Excluded opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + context - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] - - Case: + Context associated with the xml file produced. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + fatal: True + + default values: dict[context] + + num type: 'string' + + data_request_config + + Configuration file of the data request content to be used + + fatal: False + + default values: - value: internal[excluded_opportunities_lset] + - laboratory[data_request_config] + - '/home/rigoudyg/dev/DR2XML/dr2xml_source/dr2xml/dr_interface/CMIP7_config' + + num type: 'string' + + data_request_content_version + + Version of the data request content to be used + + fatal: False + + default values: - - num type: 'string' - - select_excluded_pairs - - Excluded pairs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[data_request_content_version] + - 'latest_stable' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + data_request_path + + Path where the data request API used is placed. + + fatal: False + + default values: - value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + - laboratory[data_request_path] + - None + + num type: 'string' + + data_request_used + + The Data Request infrastructure type which should be used. + + fatal: False + + default values: - Case: + - laboratory[data_request_used] + - 'CMIP6' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + debug_parsing + + In order to identify which xml files generates a problem, you can use this flag. + + fatal: False + + default values: - value: internal[excluded_pairs_lset] + - laboratory[debug_parsing] + - False + + num type: 'string' + + dr2xml_manages_enddate + + A smart workflow will allow you to extend a simulation during it course and to complement the output files accordingly, by managing the 'end date' part in filenames. You can then set next setting to False. + + fatal: True + + default values: - - num type: 'string' - - select_excluded_request_links - - Excluded request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[dr2xml_manages_enddate] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + end_year + + If you want to carry on the experiment beyond the duration set in DR, and that all requestItems that apply to DR end year also apply later on, set 'end_year' You can also set it if you don't know if DR has a wrong value + + fatal: False + + default values: - value: internal[excluded_request_links] + - simulation[end_year] + - False + + num type: 'string' + + excluded_opportunities_lset + + List of the opportunities that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_opportunities] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: None - - - num type: 'string' - - select_excluded_tables - - Excluded tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + excluded_opportunities_sset + + List of the opportunities that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + - simulation[excluded_opportunities] + - [] + + num type: 'string' + + excluded_pairs_lset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_pairs] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_pairs_sset + + You can exclude some (variable, table) pairs from outputs. A list of tuple (variable, table) to be excluded from simulation settings. + + fatal: False + + default values: - value: internal[excluded_tables_lset] + - simulation[excluded_pairs] + - [] + + num type: 'string' + + excluded_request_links + + List of links un data request that should not been followed (those request are not taken into account). + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vargroups - - Excluded variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_request_links] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_spshapes_lset + + The list of shapes that should be excluded (all variables in those shapes will be excluded from outputs). + + fatal: False + + default values: - value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + - laboratory[excluded_spshapes] + - [] + + num type: 'string' + + excluded_tables_lset + + List of the tables that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_tables_sset + + List of the tables that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - value: internal[excluded_vargroups_lset] + - simulation[excluded_tables] + - [] + + num type: 'string' + + excluded_vargroups_lset + + List of the variables groups that will be excluded from outputs from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_excluded_vars - - Excluded variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[excluded_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + excluded_vargroups_sset + + List of the variables groups that will be excluded from outputs from simulation settings. + + fatal: False + + default values: - value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + - simulation[excluded_vargroups] + - [] + + num type: 'string' + + excluded_vars_lset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[excluded_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + excluded_vars_per_config + + A dictionary which keys are configurations and values the list of variables that must be excluded for each configuration. + + fatal: False + + default values: - value: internal[excluded_vars_lset] + - laboratory[excluded_vars_per_config][internal[configuration]] + - [] + + num type: 'string' + + excluded_vars_sset + + List of CMOR variables to exclude from the result based on previous Data Request extraction from simulation settings. + + fatal: False + + default values: - - num type: 'string' - - select_grid_choice - - Grid choice for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[excluded_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + experiment_for_requests + + Experiment id to use for driving the use of the Data Request. + + fatal: True + + default values: None + + num type: 'string' + + experiment_id + + Root experiment identifier. + + fatal: True + + default values: None + + num type: 'string' + + filter_on_realization + + If you want to produce the same variables set for all members, set this parameter to False. + + fatal: False + + default values: - value: internal[grid_choice] + - simulation[filter_on_realization] + - laboratory[filter_on_realization] + - True + + num type: 'string' + + fx_from_file + + You may provide some variables already horizontally remapped to some grid (i.e. Xios domain) in external files. The varname in file must match the referenced id in pingfile. Tested only for fixed fields. A dictionary with variable id as key and a dictionary as value: the key must be the grid id, the value a dictionary with the file for each resolution. + + fatal: False + + default values: - Case: + - laboratory[fx_from_file] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + grid_choice + + A dictionary which keys are models name and values the corresponding resolution. + + fatal: True + + default values: None + + num type: 'string' + + grid_policy + + The grid choice policy for output files. + + fatal: True + + default values: None + + num type: 'string' + + grid_prefix + + Prefix of the dr2xml generated grid named to be used. + + fatal: True + + default values: - value: 'LR' + - laboratory[grid_prefix] + - internal[ping_variables_prefix] + + num type: 'string' + + grids + + Grids : per model resolution and per context :- CMIP6 qualifier (i.e. 'gn' or 'gr') for the main grid chosen (because you may choose has main production grid a regular one, when the native grid is e.g. unstructured)- Xios id for the production grid (if it is not the native grid),- Xios id for the latitude axis used for zonal means (mist match latitudes for grid above)- resolution of the production grid (using CMIP6 conventions),- grid description + + fatal: True + + default values: None + + num type: 'string' + + grids_dev + + Grids definition for dev variables. + + fatal: True + + default values: - - num type: 'string' - - select_included_opportunities - - Included opportunities for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[grids_dev] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + grouped_vars_per_file + + Variables to be grouped in the same output file (provided additional conditions are filled). + + fatal: False + + default values: - value: internal[included_opportunities] + - simulation[grouped_vars_per_file] + - laboratory[grouped_vars_per_file] + - [] + + num type: 'string' + + included_opportunities + + List of opportunities that will be processed (all others will not). + + fatal: False + + default values: - Case: + - simulation[included_opportunities] + - internal[included_opportunities_lset] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_opportunities_lset + + List of opportunities that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - value: internal[included_opportunities_lset] + - laboratory[included_opportunities] + - [] + + num type: 'string' + + included_request_links + + List of the request links that will be processed (all others will not). + + fatal: False + + default values: - - num type: 'string' - - select_included_request_links - - Included request links for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_request_links] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_tables + + List of tables that will be processed (all others will not). + + fatal: False + + default values: - value: internal[included_request_links] + - simulation[included_tables] + - internal[included_tables_lset] + + num type: 'string' + + included_tables_lset + + List of tables that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_tables] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + included_vargroups + + List of variables groups that will be processed (all others will not). + + fatal: False + + default values: - value: None + - simulation[included_vargroups] + - internal[included_vargroups_lset] + + num type: 'string' + + included_vargroups_lset + + List of variables groups that will be processed (all others will not) from laboratory settings. + + fatal: False + + default values: - - num type: 'string' - - select_included_tables - - Included tables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[included_vargroups] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + included_vars + + Variables to be considered from the Data Request (all others will not) + + fatal: False + + default values: - value: internal[included_tables] + - simulation[included_vars] + - internal[included_vars_lset] + + num type: 'string' + + included_vars_lset + + Variables to be considered from the Data Request (all others will not) from laboratory settings. + + fatal: False + + default values: - Case: + - laboratory[included_vars] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_tables_lset] - - - num type: 'string' - - select_included_vargroups - - Included variables groups for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vargroups] - - Case: + institution_id - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vargroups_lset] - - - num type: 'string' - - select_included_vars - - Included variables for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + Institution identifier. - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[included_vars] - - Case: + fatal: True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[included_vars_lset] - - - num type: 'string' - - select_max_priority - - Max priority for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + default values: laboratory[institution_id] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - - - value: internal[max_priority] - - Case: + num type: 'string' - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[max_priority_lset] - - - num type: 'string' - - select_mips - - MIPs for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + laboratory_used - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + File which contains the settings to be used for a specific laboratory which is not present by default in dr2xml. Must contains at least the `lab_grid_policy` function. + + fatal: False + + default values: - value: internal[mips][internal[select_grid_choice]]sort_mips() + - laboratory[laboratory_used] + - None + + num type: 'string' + + listof_home_vars + + Full path to the file which contains the list of home variables to be taken into account, in addition to the Data Request. + + fatal: False + + default values: - Case: + - simulation[listof_home_vars] + - laboratory[listof_home_vars] + - None - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + max_file_size_in_floats + + The maximum size of generated files in number of floating values. + + fatal: False + + default values: - value: internal[mips]sort_mips() + - laboratory[max_file_size_in_floats] + - 500000000.0 + + num type: 'string' + + max_priority + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time). + + fatal: True + + default values: - - num type: 'string' - - select_on_expt - - Should data be selected on experiment? - - fatal: True - - default values: [] - - cases: - Case: + - simulation[max_priority] + - internal[max_priority_lset] - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'on_expt_and_year' - - 'on_expt' - + num type: 'string' + + max_priority_lset + + Max variable priority level to be output (you may set 3 when creating ping_files while being more restrictive at run time) from lab settings. + + fatal: True + + default values: laboratory[max_priority] + + num type: 'string' + + max_split_freq + + The maximum number of years that should be putted in a single file. + + fatal: True + + default values: - value: True + - simulation[max_split_freq] + - laboratory[max_split_freq] + - None + + num type: 'string' + + mips + + A dictionary in which keys are grid and values a set of strings corresponding to MIPs names. + + fatal: True + + default values: laboratory[mips] + + num type: 'string' + + nemo_sources_management_policy_master_of_the_world + + Set that to True if you use a context named 'nemo' and the corresponding model unduly sets a general freq_op AT THE FIELD_DEFINITION GROUP LEVEL. Due to Xios rules for inheritance, that behavior prevents inheriting specific freq_ops by reference from dr2xml generated field_definitions. + + fatal: True + + default values: - Case: + - laboratory[nemo_sources_management_policy_master_of_the_world] + - False - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'no' - + num type: 'string' + + non_standard_attributes + + You may add a series of NetCDF attributes in all files for this simulation + + fatal: False + + default values: - value: False + - laboratory[non_standard_attributes] + - {} + + num type: 'string' + + non_standard_axes + + If your model has some axis which does not have all its attributes as in DR, and you want dr2xml to fix that it, give here the correspondence from model axis id to DR dim/grid id. For label dimensions you should provide the list of labels, ordered as in your model, as second element of a pair. Label-type axes will be processed even if not quoted. Scalar dimensions are not concerned by this feature. A dictionary with (axis_id, axis_correct_id) or (axis_id, tuple of labels) as key, values. + + fatal: False + + default values: - - num type: 'string' - - select_on_year - - Should data be selected on year? - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[non_standard_axes] + - {} - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: 'on_expt_and_year' - + num type: 'string' + + orography_field_name + + Name of the orography field name to be used to compute height over orog fields. + + fatal: False + + default values: - value: internal[year] + - laboratory[orography_field_name] + - 'orog' + + num type: 'string' + + orphan_variables + + A dictionary with (context name, list of variables) as (key,value) pairs, where the list indicates the variables to be re-affected to the key-context (initially affected to a realm falling in another context) + + fatal: True + + default values: [] + + num type: 'string' + + path_extra_tables + + Full path of the directory which contains extra tables. + + fatal: False + + default values: - Case: + - simulation[path_extra_tables] + - laboratory[path_extra_tables] + - None - conditions: - Condition: - - check value: internal[select] - - check to do: 'eq' - - reference values: - - - 'no' - - 'on_expt' - + num type: 'string' + + path_special_defs + + TODO + + fatal: False + + default values: laboratory[path_special_defs] + + num type: 'string' + + path_to_parse + + The path of the directory which, at run time, contains the root XML file (iodef.xml). + + fatal: False + + default values: - value: None + - laboratory[path_to_parse] + - './' + + num type: 'string' + + perso_sdims_description + + A dictionary containing, for each perso or dev variables with a XY-perso shape, and for each vertical coordinate associated, the main attributes of the dimension. + + fatal: False + + default values: - - num type: 'string' - - select_sizes - - Sizes for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - simulation[perso_sdims_description] + - {} - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + ping_variables_prefix + + The tag used to prefix the variables in the ‘field id’ namespaces of the ping file; may be an empty string. + + fatal: True + + default values: laboratory[ping_variables_prefix] + + num type: 'string' + + prefixed_orography_field_name + + Name of the orography field name to be used to compute height over orog fields prefixed with :term:`ping_variable_prefix`. + + fatal: False + + default values: '{}{}'.format(internal[ping_variables_prefix], internal[orography_field_name]) + + num type: 'string' + + print_stats_per_var_label + + For an extended printout of selected CMOR variables, grouped by variable label. + + fatal: False + + default values: - value: internal[sizes] + - laboratory[print_stats_per_var_label] + - False + + num type: 'string' + + print_variables + + If the value is a list, only the file/field variables listed here will be put in output files. If boolean, tell if the file/field variables should be put in output files. + + fatal: False + + default values: - Case: + - laboratory[print_variables] + - True - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - + num type: 'string' + + project + + Project associated with the simulation. + + fatal: False + + default values: - value: None + - laboratory[project] + - 'CMIP6' + + num type: 'string' + + project_settings + + Project settings definition file to be used. + + fatal: False + + default values: - - num type: 'string' - - select_tierMax - - tierMax for variable selection. - - fatal: True - - default values: [] - - cases: - Case: + - laboratory[project_settings] + - internal[project] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: True - + num type: 'string' + + realization_index + + Realization number. + + fatal: False + + default values: - value: internal[tierMax] + - simulation[realization_index] + - '1' + + num type: 'string' + + realms_per_context + + A dictionary which keys are context names and values the lists of realms associated with each context + + fatal: True + + default values: laboratory[realms_per_context][internal[context]] + + num type: 'string' + + required_model_components + + Dictionary which gives, for each model name, the components that must be present. + + fatal: True + + default values: - Case: + - laboratory[required_model_components][internal[source_id]] + - [] - conditions: - Condition: - - check value: internal[select_on_expt] - - check to do: 'eq' - - reference values: False - - - value: internal[tierMax_lset] + num type: 'string' + + sampling_timestep + + Basic sampling timestep set in your field definition (used to feed metadata 'interval_operation'). Should be a dictionary which keys are resolutions and values a context/timestep dictionary. + + fatal: True + + default values: None + + num type: 'string' + + save_project_settings + + The path of the file where the complete project settings will be written, if needed. + + fatal: False + + default values: - - num type: 'string' - - simple_domain_grid_regexp - - If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix - - fatal: False - - default values: laboratory[simple_domain_grid_regexp] - - num type: 'string' - - sizes - - A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. - - fatal: True - - default values: None - - num type: 'string' - - source_id - - Name of the model used. - - fatal: True - - default values: None - - num type: 'string' - - source_type - - If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit - - fatal: True - - default values: None - - num type: 'string' - - special_timestep_vars - - This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. - - fatal: False - - default values: + - laboratory[save_project_settings] + - None - - laboratory[special_timestep_vars] - - [] - - num type: 'string' - - split_frequencies - - Path to the split frequencies file to be used. - - fatal: False - - default values: + num type: 'string' - - simulation[split_frequencies] - - laboratory[split_frequencies] - - 'splitfreqs.dat' - - 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. - - fatal: True - - default values: + sectors - - simulation[tierMax] - - internal[tierMax_lset] - - num type: 'string' - - tierMax_lset - - Number indicating the maximum tier to consider for experiments from lab settings. - - fatal: True - - default values: laboratory[tierMax] - - num type: 'string' - - too_long_periods - - The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. - - fatal: True - - default values: + List of the sectors to be considered. - - laboratory[too_long_periods] - - [] - - num type: 'string' - - useAtForInstant - - Should xml output files use the `@` symbol for definitions for instant variables? - - fatal: False - - default values: + fatal: False - - laboratory[useAtForInstant] - - False - - num type: 'string' - - use_cmorvar_label_in_filename - - CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. - - fatal: True - - default values: + default values: laboratory[sectors] - - laboratory[use_cmorvar_label_in_filename] - - False - - num type: 'string' - - use_union_zoom - - Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. - - fatal: False - - default values: + num type: 'string' - - laboratory[use_union_zoom] - - False - - num type: 'string' - - vertical_interpolation_operation - - Operation done for vertical interpolation. - - fatal: False - - default values: + select - - laboratory[vertical_interpolation_operation] - - 'instant' - - num type: 'string' - - vertical_interpolation_sample_freq - - Time frequency of vertical interpolation. - - fatal: False - - default values: laboratory[vertical_interpolation_sample_freq] - - num type: 'string' - - xios_version - - Version of XIOS used. - - fatal: False - - default values: + Selection strategy for variables. - - laboratory[xios_version] - - 2 - - num type: 'string' - - year - - Year associated with the launch of dr2xml. - - fatal: True - - default values: dict[year] - - num type: 'string' - - zg_field_name - - Name of the geopotential height field name to be used to compute height over orog fields. - - fatal: False - - default values: + fatal: True - - laboratory[zg_field_name] - - 'zg' - - num type: 'string' - -Common values -------------- -.. glossary:: - :sorted: - - HDL - - HDL associated with the project. - - fatal: False - - default values: + default values: dict[select] - - simulation[HDL] - - laboratory[HDL] - - num type: 'string' - - activity_id - - MIP(s) name(s). - - fatal: False - - default values: + authorized values: + + - 'on_expt_and_year' + - 'on_expt' + - 'no' - - simulation[activity_id] - - laboratory[activity_id] - - num type: 'string' - - branch_method - - Branching procedure. - - fatal: False - - default values: + num type: 'string' - - simulation[branch_method] - - 'standard' - - num type: 'string' - - branch_month_in_parent - - Branch month in parent simulation with respect to its time axis. - - fatal: False - - default values: + select_excluded_opportunities - - simulation[branch_month_in_parent] - - '1' - - num type: 'string' - - branch_year_in_parent - - Branch year in parent simulation with respect to its time axis. - - fatal: False - - default values: [] - - skip values: + Excluded opportunities for variable selection. - - None - - 'None' - - '' - - 'N/A' - - cases: - Case: + fatal: True - conditions: - Condition: - - check value: internal[experiment_id] - - check to do: 'eq' - - reference values: internal[branching] + default values: [] + + cases: + Case: + + conditions: + Condition: - Condition: - - check value: simulation[branch_year_in_parent] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_opportunities_lset]', 'internal[excluded_opportunities_sset]'] + + Case: + + conditions: + Condition: - check to do: 'eq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_opportunities_lset] + + + num type: 'string' + + select_excluded_pairs + + Excluded pairs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching][internal[experiment_id]][1] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_pairs_lset]', 'internal[excluded_pairs_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_pairs_lset] + + + num type: 'string' + + select_excluded_request_links + + Excluded request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[excluded_request_links] + + Case: - Case: - - conditions: - Condition: - - check value: internal[experiment_id] + conditions: + Condition: - check to do: 'neq' + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_excluded_tables + + Excluded tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: - reference values: internal[branching] + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_tables_lset]', 'internal[excluded_tables_sset]'] + + Case: + + conditions: + Condition: + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_tables_lset] + + + num type: 'string' + + select_excluded_vargroups + + Excluded variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: - value: simulation[branch_year_in_parent] + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vargroups_lset]', 'internal[excluded_vargroups_sset]'] + + Case: - - num type: 'string' - - comment_lab - - A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vargroups_lset] + - - laboratory[comment] - - '' - - num type: 'string' - - comment_sim - - A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. - - fatal: False - - default values: + num type: 'string' - - simulation[comment] - - '' - - num type: 'string' - - compression_level - - The compression level to be applied to NetCDF output files. - - fatal: False - - default values: + select_excluded_vars - - laboratory[compression_level] - - '0' - - num type: 'string' - - contact - - Email address of the data producer. - - fatal: False - - default values: + Excluded variables for variable selection. - - simulation[contact] - - laboratory[contact] - - 'None' - - num type: 'string' - - convention_str - - Version of the conventions used. - - fatal: False - - default values: dr2xml.config.conventions - - num type: 'string' - - data_specs_version - - Version of the data request used. - - fatal: True - - default values: data_request.get_version() - - num type: 'string' - - date_range - - Date range format to be used in file definition names. - - fatal: False - - default values: '%start_date%-%end_date%' - - num type: 'string' - - description - - Description of the simulation. - - fatal: False + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: ['internal[excluded_vars_lset]', 'internal[excluded_vars_sset]', 'internal[excluded_vars_per_config]'] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[excluded_vars_lset] + + + num type: 'string' + + select_grid_choice + + Grid choice for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[grid_choice] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: 'LR' + + + num type: 'string' + + select_included_opportunities + + Included opportunities for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_opportunities] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_opportunities_lset] + + + num type: 'string' + + select_included_request_links + + Included request links for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_request_links] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_included_tables + + Included tables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_tables] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_tables_lset] + + + num type: 'string' + + select_included_vargroups + + Included variables groups for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vargroups] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vargroups_lset] + + + num type: 'string' + + select_included_vars + + Included variables for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[included_vars] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[included_vars_lset] + + + num type: 'string' + + select_max_priority + + Max priority for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[max_priority] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[max_priority_lset] + + + num type: 'string' + + select_mips + + MIPs for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[mips][internal[select_grid_choice]]sort_mips() + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[mips]sort_mips() + + + num type: 'string' + + select_on_expt + + Should data be selected on experiment? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'on_expt_and_year' + - 'on_expt' + + + value: True + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'no' + + + value: False + + + num type: 'string' + + select_on_year + + Should data be selected on year? + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: 'on_expt_and_year' + + + value: internal[year] + + Case: + + conditions: + Condition: + + check value: internal[select] + + check to do: 'eq' + + reference values: + + - 'no' + - 'on_expt' + + + value: None + + + num type: 'string' + + select_sizes + + Sizes for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[sizes] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: None + + + num type: 'string' + + select_tierMax + + tierMax for variable selection. + + fatal: True + + default values: [] + + cases: + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: True + + + value: internal[tierMax] + + Case: + + conditions: + Condition: + + check value: internal[select_on_expt] + + check to do: 'eq' + + reference values: False + + + value: internal[tierMax_lset] + + + num type: 'string' + + simple_domain_grid_regexp + + If some grid is not defined in xml but by API, and is referenced by a field which is considered by the DR as having a singleton dimension, then: 1) it must be a grid which has only a domain 2) the domain name must be extractable from the grid_id using a regexp and a group number Example: using a pattern that returns full id except for a '_grid' suffix + + fatal: False + + default values: laboratory[simple_domain_grid_regexp] + + num type: 'string' + + sizes + + A dictionary which keys are resolution and values the associated grid size for atmosphere and ocean grids. The grid size looks like : ['nho', 'nlo', 'nha', 'nla', 'nlas', 'nls', 'nh1']. Used to compute file split frequency. + + fatal: True + + default values: None + + num type: 'string' + + source_id + + Name of the model used. + + fatal: True + + default values: None + + num type: 'string' + + source_type + + If the default source-type value for your source (:term:`source_types` from :term:`lab_and_model_settings`) does not fit, you may change it here. This should describe the model most directly responsible for the output. Sometimes it is appropriate to list two (or more) model types here, among AER, AGCM, AOGCM, BGC, CHEM, ISM, LAND, OGCM, RAD, SLAB e.g. amip , run with CNRM-CM6-1, should quote "AGCM AER". Also see note 14 of https://docs.google.com/document/d/1h0r8RZr_f3-8egBMMh7aqLwy3snpD6_MrDz1q8n5XUk/edit + + fatal: True + + default values: None + + num type: 'string' + + special_timestep_vars + + This variable is used when some variables are computed with a period which is not the basic timestep. A dictionary which keys are non standard timestep and values the list of variables which are computed at this timestep. + + fatal: False + + default values: + + - laboratory[special_timestep_vars] + - [] + + num type: 'string' + + split_frequencies + + Path to the split frequencies file to be used. + + fatal: False + + default values: + + - simulation[split_frequencies] + - laboratory[split_frequencies] + - 'splitfreqs.dat' + + num type: 'string' + + synchronisation_frequency + + Frequency at which the synchronisation between buffer and filesystem is done. + + fatal: False + + default values: [] + + num type: 'string' + + tierMax + + Number indicating the maximum tier to consider for experiments. + + fatal: True + + default values: + + - simulation[tierMax] + - internal[tierMax_lset] + + num type: 'string' + + tierMax_lset + + Number indicating the maximum tier to consider for experiments from lab settings. + + fatal: True + + default values: laboratory[tierMax] + + num type: 'string' + + too_long_periods + + The CMIP6 frequencies that are unreachable for a single model run. Datafiles will be labelled with dates consistent with content (but not with CMIP6 requirements). Allowed values are only 'dec' and 'yr'. + + fatal: True + + default values: + + - laboratory[too_long_periods] + - [] + + num type: 'string' + + useAtForInstant + + Should xml output files use the `@` symbol for definitions for instant variables? + + fatal: False + + default values: + + - laboratory[useAtForInstant] + - False + + num type: 'string' + + use_cmorvar_label_in_filename + + CMIP6 rule is that filenames includes the variable label, and that this variable label is not the CMORvar label, but 'MIPvar' label. This may lead to conflicts, e.g. for 'ua' and 'ua7h' in table 6hPlevPt; allows to avoid that, if set to True. + + fatal: True + + default values: + + - laboratory[use_cmorvar_label_in_filename] + - False + + num type: 'string' + + use_union_zoom + + Say if you want to use XIOS union/zoom axis to optimize vertical interpolation requested by the DR. + + fatal: False + + default values: + + - laboratory[use_union_zoom] + - False + + num type: 'string' + + vertical_interpolation_operation + + Operation done for vertical interpolation. + + fatal: False + + default values: + + - laboratory[vertical_interpolation_operation] + - 'instant' + + num type: 'string' + + vertical_interpolation_sample_freq + + Time frequency of vertical interpolation. + + fatal: False + + default values: laboratory[vertical_interpolation_sample_freq] + + num type: 'string' + + xios_version + + Version of XIOS used. + + fatal: False + + default values: + + - laboratory[xios_version] + - 2 + + num type: 'string' + + year + + Year associated with the launch of dr2xml. + + fatal: True + + default values: dict[year] + + num type: 'string' + + zg_field_name + + Name of the geopotential height field name to be used to compute height over orog fields. + + fatal: False + + default values: + + - laboratory[zg_field_name] + - 'zg' + + num type: 'string' + + Common values + ^^^^^^^^^^^^^ + .. glossary:: + :sorted: - default values: + HDL + + HDL associated with the project. + + fatal: False + + default values: + + - simulation[HDL] + - laboratory[HDL] + + num type: 'string' + + activity_id + + MIP(s) name(s). + + fatal: False + + default values: + + - simulation[activity_id] + - laboratory[activity_id] + + num type: 'string' + + branch_method + + Branching procedure. + + fatal: False + + default values: + + - simulation[branch_method] + - 'standard' + + num type: 'string' + + branch_month_in_parent + + Branch month in parent simulation with respect to its time axis. + + fatal: False + + default values: + + - simulation[branch_month_in_parent] + - '1' + + num type: 'string' + + branch_year_in_parent + + Branch year in parent simulation with respect to its time axis. + + fatal: False + + default values: [] + + skip values: + + - None + - 'None' + - '' + - 'N/A' + + cases: + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'eq' + + reference values: internal[branching] + + Condition: + + check value: simulation[branch_year_in_parent] + + check to do: 'eq' + + reference values: internal[branching][internal[experiment_id]][1] + + + value: simulation[branch_year_in_parent] + + Case: + + conditions: + Condition: + + check value: internal[experiment_id] + + check to do: 'neq' + + reference values: internal[branching] + + + value: simulation[branch_year_in_parent] + + + num type: 'string' + + comment_lab + + A character string containing additional information about the models from laboratory settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - laboratory[comment] + - '' + + num type: 'string' + + comment_sim + + A character string containing additional information about the models from simulation settings. Will be complemented with the experiment's specific comment string. + + fatal: False + + default values: + + - simulation[comment] + - '' + + num type: 'string' + + compression_level + + The compression level to be applied to NetCDF output files. + + fatal: False + + default values: + + - laboratory[compression_level] + - '0' + + num type: 'string' + + contact + + Email address of the data producer. + + fatal: False + + default values: + + - simulation[contact] + - laboratory[contact] + - 'None' + + num type: 'string' + + convention_str + + Version of the conventions used. + + fatal: False + + default values: dr2xml.config.conventions + + num type: 'string' + + data_specs_version + + Version of the data request used. + + fatal: True + + default values: data_request.get_version() + + num type: 'string' + + date_range + + Date range format to be used in file definition names. + + fatal: False + + default values: '%start_date%-%end_date%' + + num type: 'string' + + description + + Description of the simulation. + + fatal: False + + default values: + + - simulation[description] + - laboratory[description] + + num type: 'string' - - simulation[description] - - laboratory[description] - - num type: 'string' - - dr2xml_version - - Version of dr2xml used. - - fatal: False - - default values: dr2xml.config.version - - num type: 'string' - - experiment - - Name of the experiment. - - fatal: False - - default values: simulation[experiment] - - num type: 'string' - - expid_in_filename - - Experiment label to use in file names and attribute. - - fatal: False - - default values: + dr2xml_version - - simulation[expid_in_filename] - - internal[experiment_id] - - forbidden patterns: '.*_.*' - - num type: 'string' - - forcing_index - - Index for variant of forcing. - - fatal: False - - default values: + Version of dr2xml used. - - simulation[forcing_index] - - '1' - - num type: 'string' - - history - - In case of replacement of previously produced data, description of any changes in the production chain. - - fatal: False - - default values: + fatal: False - - simulation[history] - - 'none' - - num type: 'string' - - info_url - - Location of documentation. - - fatal: False - - default values: laboratory[info_url] - - num type: 'string' - - initialization_index - - Index for variant of initialization method. - - fatal: False - - default values: + default values: dr2xml.config.version - - simulation[initialization_index] - - '1' - - num type: 'string' - - institution - - Full name of the institution of the data producer. - - fatal: False - - default values: laboratory[institution] - - num type: 'string' - - list_perso_dev_file - - Name of the file which will contain the list of the patterns of perso and dev output file definition. - - fatal: False - - default values: 'dr2xml_list_perso_and_dev_file_names' - - num type: 'string' - - mip_era - - MIP associated with the simulation. - - fatal: False - - default values: + num type: 'string' - - simulation[mip_era] - - laboratory[mip_era] - - num type: 'string' - - output_level - - We can control the max output level set for all output files. - - fatal: False - - default values: + experiment - - laboratory[output_level] - - '10' - - num type: 'string' - - parent_activity_id - - Description of sub-experiment. - - fatal: False - - default values: + Name of the experiment. - - simulation[parent_activity_id] - - simulation[activity_id] - - laboratory[parent_activity_id] - - laboratory[activity_id] - - num type: 'string' - - parent_experiment_id - - Parent experiment identifier. - - fatal: False - - default values: + fatal: False - - simulation[parent_experiment_id] - - laboratory[parent_experiment_id] - - num type: 'string' - - parent_mip_era - - Parent’s associated MIP cycle. - - fatal: False - - default values: simulation[parent_mip_era] - - num type: 'string' - - parent_source_id - - Parent model identifier. - - fatal: False - - default values: simulation[parent_source_id] - - num type: 'string' - - parent_time_ref_year - - Reference year in parent simulation. - - fatal: False - - default values: + default values: simulation[experiment] - - simulation[parent_time_ref_year] - - '1850' - - num type: 'string' - - parent_time_units - - Time units used in parent. - - fatal: False - - default values: simulation[parent_time_units] - - num type: 'string' - - parent_variant_label - - Parent variant label. - - fatal: False - - default values: simulation[parent_variant_label] - - num type: 'string' - - physics_index - - Index for model physics variant. - - fatal: False - - default values: + num type: 'string' - - simulation[physics_index] - - '1' - - num type: 'string' - - prefix - - Prefix to be used for each file definition. - - fatal: True - - default values: dict[prefix] - - num type: 'string' - - references - - References associated with the simulation. - - fatal: False - - default values: laboratory[references] - - num type: 'string' - - source - - Name of the model. - - fatal: False - - default values: laboratory[source] - - num type: 'string' - - sub_experiment - - Sub-experiment name. - - fatal: False - - default values: + expid_in_filename - - simulation[sub_experiment] - - 'none' - - num type: 'string' - - sub_experiment_id - - Sub-experiment identifier. - - fatal: False - - default values: + Experiment label to use in file names and attribute. + + fatal: False + + default values: + + - simulation[expid_in_filename] + - internal[experiment_id] + + forbidden patterns: '.*_.*' + + num type: 'string' + + forcing_index + + Index for variant of forcing. + + fatal: False + + default values: + + - simulation[forcing_index] + - '1' + + num type: 'string' + + history + + In case of replacement of previously produced data, description of any changes in the production chain. + + fatal: False + + default values: + + - simulation[history] + - 'none' + + num type: 'string' + + info_url + + Location of documentation. + + fatal: False + + default values: laboratory[info_url] + + num type: 'string' + + initialization_index + + Index for variant of initialization method. + + fatal: False + + default values: + + - simulation[initialization_index] + - '1' + + num type: 'string' + + institution + + Full name of the institution of the data producer. + + fatal: False + + default values: laboratory[institution] + + num type: 'string' + + list_perso_dev_file + + Name of the file which will contain the list of the patterns of perso and dev output file definition. + + fatal: False + + default values: 'dr2xml_list_perso_and_dev_file_names' + + num type: 'string' + + mip_era + + MIP associated with the simulation. + + fatal: False + + default values: + + - simulation[mip_era] + - laboratory[mip_era] + + num type: 'string' + + output_level + + We can control the max output level set for all output files. + + fatal: False + + default values: + + - laboratory[output_level] + - '10' + + num type: 'string' + + parent_activity_id + + Description of sub-experiment. + + fatal: False + + default values: + + - simulation[parent_activity_id] + - simulation[activity_id] + - laboratory[parent_activity_id] + - laboratory[activity_id] + + num type: 'string' + + parent_experiment_id + + Parent experiment identifier. + + fatal: False + + default values: + + - simulation[parent_experiment_id] + - laboratory[parent_experiment_id] + + num type: 'string' + + parent_mip_era + + Parent’s associated MIP cycle. + + fatal: False + + default values: simulation[parent_mip_era] + + num type: 'string' + + parent_source_id + + Parent model identifier. + + fatal: False + + default values: simulation[parent_source_id] + + num type: 'string' + + parent_time_ref_year + + Reference year in parent simulation. + + fatal: False + + default values: + + - simulation[parent_time_ref_year] + - '1850' + + num type: 'string' + + parent_time_units + + Time units used in parent. + + fatal: False + + default values: simulation[parent_time_units] + + num type: 'string' + + parent_variant_label + + Parent variant label. + + fatal: False + + default values: simulation[parent_variant_label] + + num type: 'string' + + physics_index + + Index for model physics variant. + + fatal: False + + default values: + + - simulation[physics_index] + - '1' + + num type: 'string' + + prefix + + Prefix to be used for each file definition. + + fatal: True + + default values: dict[prefix] + + num type: 'string' + + references + + References associated with the simulation. + + fatal: False + + default values: laboratory[references] + + num type: 'string' + + source + + Name of the model. + + fatal: False + + default values: laboratory[source] + + num type: 'string' + + sub_experiment + + Sub-experiment name. + + fatal: False + + default values: + + - simulation[sub_experiment] + - 'none' + + num type: 'string' + + sub_experiment_id + + Sub-experiment identifier. + + fatal: False + + default values: + + - simulation[sub_experiment_id] + - 'none' + + num type: 'string' + + variant_info + + It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' + + fatal: False + + default values: simulation[variant_info] + + skip values: '' + + num type: 'string' - - simulation[sub_experiment_id] - - 'none' - - num type: 'string' - - variant_info - - It is recommended that some description be included to help identify major differences among variants, but care should be taken to record correct information. dr2xml will add in all cases: 'Information provided by this attribute may in some cases be flawed. Users can find more comprehensive and up-to-date documentation via the further_info_url global attribute.' - - fatal: False - - default values: simulation[variant_info] - - skip values: '' - - num type: 'string' - Project settings ---------------- .. glossary::