workflow

Path	Dimensions	Type	Units	Description
workflow (alpha)				Description of the workflow that has produced this data entry. The workflow IDS can also be used to communicate information about workflow state between workflow components.
workflow.code (alpha)		STRUCTURE		Generic decription of the code-specific parameters for the code that has produced this IDS
workflow.code.commit (alpha)		STR_0D		Unique commit reference of software
workflow.code.description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.code.library (alpha)	[1...N]	STRUCT_ARRAY		List of external libraries used by the code that has produced this IDS
workflow.code.library[:].commit (alpha)		STR_0D		Unique commit reference of software
workflow.code.library[:].description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.code.library[:].name (alpha)		STR_0D		Name of software
workflow.code.library[:].parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.code.library[:].repository (alpha)		STR_0D		URL of software repository
workflow.code.library[:].version (alpha)		STR_0D		Unique version (tag) of software
workflow.code.name (alpha)		STR_0D		Name of software generating IDS
workflow.code.output_flag (alpha)	[workflow.time]	INT_1D		Output flag : 0 means the run is successful, other values mean some difficulty has been encountered, the exact meaning is then code specific. Negative values mean the result shall not be used.
workflow.code.parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.code.repository (alpha)		STR_0D		URL of software repository
workflow.code.version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties (alpha)		STRUCTURE		Interface Data Structure properties. This element identifies the node above as an IDS
workflow.ids_properties.comment (alpha)		STR_0D		Any comment describing the content of this IDS
workflow.ids_properties.creation_date (alpha)		STR_0D		Date at which this data has been produced
workflow.ids_properties.homogeneous_time (alpha)		INT_0D		This node must be filled (with 0, 1, or 2) for the IDS to be valid. If 1, the time of this IDS is homogeneous, i.e. the time values for this IDS are stored in the time node just below the root of this IDS. If 0, the time values are stored in the various time fields at lower levels in the tree. In the case only constant or static nodes are filled within the IDS, homogeneous_time must be set to 2
workflow.ids_properties.name (alpha)		STR_0D		User-defined name for this IDS occurrence
workflow.ids_properties.occurrence		INT_0D
workflow.ids_properties.occurrence_type (alpha)		STRUCTURE		Type of data contained in this occurrence 1) reconstruction : Equilibrium reconstruction 2) prediction_fixed : Equilibrium prediction, fixed boundary 3) prediction_free : Equilibrium prediction, free boundary 4) mapping : Used for mapping equilibrium results from one grid type / resolution to another, or for including variables not present in the first set such as the calculation of magnetic field of other derived parameters
workflow.ids_properties.occurrence_type.description (alpha)		STR_0D		Verbose description
workflow.ids_properties.occurrence_type.index (alpha)		INT_0D		Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index.
workflow.ids_properties.occurrence_type.name (alpha)		STR_0D		Short string identifier
workflow.ids_properties.plugins (alpha)		STRUCTURE		Information about the plugins used to write/read this IDS. This structure is filled automatically by the Access Layer at GET/PUT time, no need to fill it via a user program.
workflow.ids_properties.plugins.infrastructure_get (alpha)		STRUCTURE		Plugin infrastructure used to GET the data
workflow.ids_properties.plugins.infrastructure_get.commit (alpha)		STR_0D		Unique commit reference of software
workflow.ids_properties.plugins.infrastructure_get.description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.ids_properties.plugins.infrastructure_get.name (alpha)		STR_0D		Name of software used
workflow.ids_properties.plugins.infrastructure_get.repository (alpha)		STR_0D		URL of software repository
workflow.ids_properties.plugins.infrastructure_get.version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties.plugins.infrastructure_put (alpha)		STRUCTURE		Plugin infrastructure used to PUT the data
workflow.ids_properties.plugins.infrastructure_put.commit (alpha)		STR_0D		Unique commit reference of software
workflow.ids_properties.plugins.infrastructure_put.description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.ids_properties.plugins.infrastructure_put.name (alpha)		STR_0D		Name of software used
workflow.ids_properties.plugins.infrastructure_put.repository (alpha)		STR_0D		URL of software repository
workflow.ids_properties.plugins.infrastructure_put.version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties.plugins.node (alpha)	[1...N]	STRUCT_ARRAY		Set of IDS nodes for which a plugin has been applied
workflow.ids_properties.plugins.node[:].get_operation (alpha)	[1...N]	STRUCT_ARRAY		Plugins actually used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application). This information is filled by the plugin infrastructure during the GET operation.
workflow.ids_properties.plugins.node[:].get_operation[:].commit (alpha)		STR_0D		Unique commit reference of software
workflow.ids_properties.plugins.node[:].get_operation[:].description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.ids_properties.plugins.node[:].get_operation[:].name (alpha)		STR_0D		Name of software used
workflow.ids_properties.plugins.node[:].get_operation[:].parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.ids_properties.plugins.node[:].get_operation[:].repository (alpha)		STR_0D		URL of software repository
workflow.ids_properties.plugins.node[:].get_operation[:].version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties.plugins.node[:].path (alpha)		STR_0D		Path of the node within the IDS, following the syntax given in the link below. If empty, means the plugin applies to the whole IDS.
workflow.ids_properties.plugins.node[:].put_operation (alpha)	[1...N]	STRUCT_ARRAY		Plugins used to PUT a node (potentially, multiple plugins can be applied, if so they are listed by order of application)
workflow.ids_properties.plugins.node[:].put_operation[:].commit (alpha)		STR_0D		Unique commit reference of software
workflow.ids_properties.plugins.node[:].put_operation[:].description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.ids_properties.plugins.node[:].put_operation[:].name (alpha)		STR_0D		Name of software used
workflow.ids_properties.plugins.node[:].put_operation[:].parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.ids_properties.plugins.node[:].put_operation[:].repository (alpha)		STR_0D		URL of software repository
workflow.ids_properties.plugins.node[:].put_operation[:].version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties.plugins.node[:].readback (alpha)	[1...N]	STRUCT_ARRAY		Plugins to be used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application)
workflow.ids_properties.plugins.node[:].readback[:].commit (alpha)		STR_0D		Unique commit reference of software
workflow.ids_properties.plugins.node[:].readback[:].description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.ids_properties.plugins.node[:].readback[:].name (alpha)		STR_0D		Name of software used
workflow.ids_properties.plugins.node[:].readback[:].parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.ids_properties.plugins.node[:].readback[:].repository (alpha)		STR_0D		URL of software repository
workflow.ids_properties.plugins.node[:].readback[:].version (alpha)		STR_0D		Unique version (tag) of software
workflow.ids_properties.provenance (alpha)		STRUCTURE		Provenance information about this IDS
workflow.ids_properties.provenance.node (alpha)	[1...N]	STRUCT_ARRAY		Set of IDS nodes for which the provenance is given. The provenance information applies to the whole structure below the IDS node. For documenting provenance information for the whole IDS, set the size of this array of structure to 1 and leave the child "path" node empty
workflow.ids_properties.provenance.node[:].path (alpha)		STR_0D		Path of the node within the IDS, following the syntax given in the link below. If empty, means the provenance information applies to the whole IDS.
workflow.ids_properties.provenance.node[:].sources (alpha)	[1...N]	STR_1D		List of sources used to import or calculate this node, identified as explained below. In case the node is the result of of a calculation / data processing, the source is an input to the process described in the "code" structure at the root of the IDS. The source can be an IDS (identified by a URI or a persitent identifier, see syntax in the link below) or non-IDS data imported directly from an non-IMAS database (identified by the command used to import the source, or the persistent identifier of the data source). Often data are obtained by a chain of processes, however only the last process input are recorded here. The full chain of provenance has then to be reconstructed recursively from the provenance information contained in the data sources.
workflow.ids_properties.provider (alpha)		STR_0D		Name of the person in charge of producing this data
workflow.ids_properties.source (obsolescent)		STR_0D		Source of the data (any comment describing the origin of the data : code, path to diagnostic signals, processing method, ...). Superseeded by the new provenance structure.
workflow.ids_properties.version_put (alpha)		STRUCTURE		Version of the access layer package used to PUT this IDS
workflow.ids_properties.version_put.access_layer (alpha)		STR_0D		Version of Access Layer used to PUT this IDS
workflow.ids_properties.version_put.access_layer_language (alpha)		STR_0D		Programming language of the Access Layer high level API used to PUT this IDS
workflow.ids_properties.version_put.data_dictionary (alpha)		STR_0D		Version of Data Dictionary used to PUT this IDS
workflow.time (alpha)	[1...N]	FLT_1D_TYPE	s	Generic time
workflow.time_loop (alpha)		STRUCTURE		Description of a workflow based on a time loop which calls components defined in component_list sequentially during each cycle of the loop (workflow_cycle).
workflow.time_loop.component (alpha)	[1...N]	STRUCT_ARRAY		List of components partcipating in the workflow
workflow.time_loop.component[:].commit (alpha)		STR_0D		Unique commit reference of software
workflow.time_loop.component[:].description (alpha)		STR_0D		Short description of the software (type, purpose)
workflow.time_loop.component[:].name (alpha)		STR_0D		Name of software used
workflow.time_loop.component[:].parameters (alpha)		STR_0D		List of the code specific parameters in XML format
workflow.time_loop.component[:].repository (alpha)		STR_0D		URL of software repository
workflow.time_loop.component[:].version (alpha)		STR_0D		Unique version (tag) of software
workflow.time_loop.time_end (alpha)		FLT_0D (uncertain)	s	Termination time for the workflow main time loop
workflow.time_loop.workflow_cycle (alpha)	[workflow.time_loop.workflow_cycle[:].time]	STRUCT_ARRAY		Set of time slices corresponding to the beginning of workflow cycles (main time loop of the workflow). During each workflow cycle, active components compute their result during their given time_interval. Components having completed their computation are frozen until the end of the workflow cycle. The next workflow cycle begins when the maximum time_interval (over the components) has been reached.
workflow.time_loop.workflow_cycle[:].component (alpha)	[1...N]	STRUCT_ARRAY		Control parameters for the set of participting components defined in ../../component
workflow.time_loop.workflow_cycle[:].component[:].control_float (alpha)	[1...N]	FLT_1D (uncertain)	mixed	Array of real workflow control parameters used by this component (component specific)
workflow.time_loop.workflow_cycle[:].component[:].control_integer (alpha)	[1...N]	INT_1D		Array of integer workflow control parameters used by this component (component specific)
workflow.time_loop.workflow_cycle[:].component[:].execution_mode (alpha)		INT_0D		Component execution mode for current workflow cycle. 0 means the component is not executed and the workflow uses results from previous workflow cycle. 1 means the component is executed for this workflow cycle.
workflow.time_loop.workflow_cycle[:].component[:].index (alpha)		INT_0D		Index of the component in the ../../../component array
workflow.time_loop.workflow_cycle[:].component[:].time_interval (alpha)		FLT_0D (uncertain)	s	Simulation time interval during which this component has to compute its results.
workflow.time_loop.workflow_cycle[:].time (alpha)		FLT_0D	s	Time