Parameters available for project dr2xml
Internal values
- 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:
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:
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:
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:
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:
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:
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:
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.
atal: False
efault values:
laboratory[branching][internal[source_id]]
{}
um 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:
laboratory[bypass_CV_components]
False
num type: ‘string’
- bytes_per_float
Estimate of number of bytes per floating value, given the chosen compression_level.
fatal: False
default values:
laboratory[bytes_per_float]
2
num type: ‘string’
- CFsubhr_frequency
CFMIP has an elaborated requirement for defining subhr frequency; by default, dr2xml uses 1 time step.
fatal: False
default values:
laboratory[CFsubhr_frequency]
‘1ts’
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: source_id and, if needed, 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_path
Path where the data request used is placed.
fatal: False
default values:
laboratory[data_request_path]
None
num type: ‘string’
- data_request_used
Version of the data request used.
fatal: False
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:
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:
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:
simulation[end_year]
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:
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:
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:
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:
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:
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:
simulation[excluded_tables]
[]
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:
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:
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:
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:
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:
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:
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:
laboratory[grid_policy]
False
num type: ‘string’
- grid_prefix
Prefix of the dr2xml generated grid named to be used.
fatal: True
default values:
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:
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:
simulation[grouped_vars_per_file]
laboratory[grouped_vars_per_file]
[]
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_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]
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:
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:
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:
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:
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:
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:
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:
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 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:
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:
laboratory[print_variables]
True
num type: ‘string’
- project
Project associated with the simulation.
fatal: False
default values:
laboratory[project]
‘CMIP6’
num type: ‘string’
- project_settings
Project settings definition file to be used.
fatal: False
default values:
laboratory[project_settings]
internal[project]
num type: ‘string’
- realization_index
Realization number.
fatal: False
default values:
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:
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:
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’
- 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]]
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 (source_types from 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 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:
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’
- 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’
- useAtForInstant
Should xml output files use the @ symbol for definitions for instant variables?
fatal: False
default values:
laboratory[useAtForInstant]
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’
- 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
Project settings
- axis
XIOS axis beacon
- axis_definition
XIOS axis_definition beacon
- axis_group
XIOS axis_group beacon
- context
XIOS context beacon
- domain
XIOS domain beacon
- domain_definition
XIOS domain_definition beacon
- domain_group
XIOS domain_group beacon
- duplicate_scalar
XIOS duplicate_scalar beacon
- field
XIOS field beacon (except for output fields)
- field_definition
XIOS field_definition beacon
- field_group
XIOS field_group beacon
- field_output
XIOS field beacon (only for output fields)
- file
XIOS file beacon (except for output files)
- file_definition
XIOS file_definition beacon
- file_output
XIOS file beacon (only for output files)
- generate_rectilinear_domain
XIOS generate_rectilinear_domain beacon
- grid
XIOS grid beacon
- grid_definition
XIOS grid_definition beacon
- interpolate_axis
XIOS interpolate_axis beacon
- interpolate_domain
XIOS interpolate_domain beacon
- scalar
XIOS scalar beacon
- scalar_definition
XIOS scalar_definition beacon
- temporal_splitting
XIOS temporal_splitting beacon
- variable
XIOS variable beacon
- Attributes:
name
Content of the variable
fatal: False
default values: []
num type: ‘string’
type
Encoding type of the variable’s content.
fatal: False
default values: []
num type: ‘string’
- zoom_axis
XIOS zoom_axis beacon