User Configuration Schemas

This page documents the configuration schemas used for validation of the yaml configuration file.

Pipeline

Field	Type	Required	Default	Description
pipelines	list of dict	Optional
pipelines.name	string	Optional
pipelines.uses	string	Optional		(Excludes: steps)
pipelines.steps	list of string	Optional		(Excludes: uses)
pipelines.steps.type	string	Optional
pipelines.steps.is_qualname_or_script	bool	Optional

Rule

Field	Type	Required	Default	Description
rules	list of dict	Optional
rules.name	string	Optional
rules.cmor_variable	string	Required
rules.model_variable	string	Optional
rules.input_type	string	Optional		(Allowed: xr.DataArray, xr.Dataset)
rules.input_source	string	Optional		(Allowed: xr_tutorial)
rules.inputs	list of dict	Required
rules.inputs.path	string	Required
rules.inputs.pattern	string	Required
rules.enabled	boolean	Optional
rules.description	string	Optional
rules.pipelines	list of string	Optional
rules.pipelines.type	string	Optional
rules.cmor_unit	string	Optional
rules.model_unit	string	Optional
rules.file_timespan	string	Optional
rules.variant_label	string	Required
rules.source_id	string	Required
rules.output_directory	string	Required
rules.instition_id	string	Optional
rules.experiment_id	string	Required
rules.adjust_timestamp	string	Optional
rules.further_info_url	string	Optional
rules.model_component	string	Required
rules.grid_label	string	Required
rules.array_order	list	Optional