real time dataΒΆ

PathDimensionsTypeUnitsDescription

real_time_data

(alpha)

Description of the data bus circulating on the real time data network of the machine. This is typically used (but not only) as an interface to the Plasma Control System (PCS)

real_time_data.code

(alpha)

STRUCTURE

Generic decription of the code-specific parameters for the code that has produced this IDS

real_time_data.code.commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.code.description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.code.library

(alpha)

[1...N]

STRUCT_ARRAY

List of external libraries used by the code that has produced this IDS

real_time_data.code.library[:].commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.code.library[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.code.library[:].name

(alpha)

STR_0D

Name of software

real_time_data.code.library[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

real_time_data.code.library[:].repository

(alpha)

STR_0D

URL of software repository

real_time_data.code.library[:].version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.code.name

(alpha)

STR_0D

Name of software generating IDS

real_time_data.code.output_flag

(alpha)

[real_time_data.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.

real_time_data.code.parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

real_time_data.code.repository

(alpha)

STR_0D

URL of software repository

real_time_data.code.version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.ids_properties

(alpha)

STRUCTURE

Interface Data Structure properties. This element identifies the node above as an IDS

real_time_data.ids_properties.comment

(alpha)

STR_0D

Any comment describing the content of this IDS

real_time_data.ids_properties.creation_date

(alpha)

STR_0D

Date at which this data has been produced

real_time_data.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

real_time_data.ids_properties.name

(alpha)

STR_0D

User-defined name for this IDS occurrence

real_time_data.ids_properties.occurrence

INT_0D

real_time_data.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

real_time_data.ids_properties.occurrence_type.description

(alpha)

STR_0D

Verbose description

real_time_data.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.

real_time_data.ids_properties.occurrence_type.name

(alpha)

STR_0D

Short string identifier

real_time_data.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.

real_time_data.ids_properties.plugins.infrastructure_get

(alpha)

STRUCTURE

Plugin infrastructure used to GET the data

real_time_data.ids_properties.plugins.infrastructure_get.commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.ids_properties.plugins.infrastructure_get.description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.ids_properties.plugins.infrastructure_get.name

(alpha)

STR_0D

Name of software used

real_time_data.ids_properties.plugins.infrastructure_get.repository

(alpha)

STR_0D

URL of software repository

real_time_data.ids_properties.plugins.infrastructure_get.version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.ids_properties.plugins.infrastructure_put

(alpha)

STRUCTURE

Plugin infrastructure used to PUT the data

real_time_data.ids_properties.plugins.infrastructure_put.commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.ids_properties.plugins.infrastructure_put.description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.ids_properties.plugins.infrastructure_put.name

(alpha)

STR_0D

Name of software used

real_time_data.ids_properties.plugins.infrastructure_put.repository

(alpha)

STR_0D

URL of software repository

real_time_data.ids_properties.plugins.infrastructure_put.version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.ids_properties.plugins.node

(alpha)

[1...N]

STRUCT_ARRAY

Set of IDS nodes for which a plugin has been applied

real_time_data.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.

real_time_data.ids_properties.plugins.node[:].get_operation[:].commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.ids_properties.plugins.node[:].get_operation[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.ids_properties.plugins.node[:].get_operation[:].name

(alpha)

STR_0D

Name of software used

real_time_data.ids_properties.plugins.node[:].get_operation[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

real_time_data.ids_properties.plugins.node[:].get_operation[:].repository

(alpha)

STR_0D

URL of software repository

real_time_data.ids_properties.plugins.node[:].get_operation[:].version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.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.

real_time_data.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)

real_time_data.ids_properties.plugins.node[:].put_operation[:].commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.ids_properties.plugins.node[:].put_operation[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.ids_properties.plugins.node[:].put_operation[:].name

(alpha)

STR_0D

Name of software used

real_time_data.ids_properties.plugins.node[:].put_operation[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

real_time_data.ids_properties.plugins.node[:].put_operation[:].repository

(alpha)

STR_0D

URL of software repository

real_time_data.ids_properties.plugins.node[:].put_operation[:].version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.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)

real_time_data.ids_properties.plugins.node[:].readback[:].commit

(alpha)

STR_0D

Unique commit reference of software

real_time_data.ids_properties.plugins.node[:].readback[:].description

(alpha)

STR_0D

Short description of the software (type, purpose)

real_time_data.ids_properties.plugins.node[:].readback[:].name

(alpha)

STR_0D

Name of software used

real_time_data.ids_properties.plugins.node[:].readback[:].parameters

(alpha)

STR_0D

List of the code specific parameters in XML format

real_time_data.ids_properties.plugins.node[:].readback[:].repository

(alpha)

STR_0D

URL of software repository

real_time_data.ids_properties.plugins.node[:].readback[:].version

(alpha)

STR_0D

Unique version (tag) of software

real_time_data.ids_properties.provenance

(alpha)

STRUCTURE

Provenance information about this IDS

real_time_data.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

real_time_data.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.

real_time_data.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.

real_time_data.ids_properties.provider

(alpha)

STR_0D

Name of the person in charge of producing this data

real_time_data.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.

real_time_data.ids_properties.version_put

(alpha)

STRUCTURE

Version of the access layer package used to PUT this IDS

real_time_data.ids_properties.version_put.access_layer

(alpha)

STR_0D

Version of Access Layer used to PUT this IDS

real_time_data.ids_properties.version_put.access_layer_language

(alpha)

STR_0D

Programming language of the Access Layer high level API used to PUT this IDS

real_time_data.ids_properties.version_put.data_dictionary

(alpha)

STR_0D

Version of Data Dictionary used to PUT this IDS

real_time_data.time

(alpha)

[1...N]

FLT_1D_TYPE

s

Generic time

real_time_data.topic

(alpha)

[1...N]

STRUCT_ARRAY

List of topics. Signals are grouped by topic

real_time_data.topic[:].name

(alpha)

STR_0D

Topic name

real_time_data.topic[:].sample

(alpha)

[real_time_data.topic[:].time_stamp]

INT_1D

Index of sample (time stamp counter)

real_time_data.topic[:].signal

(alpha)

[1...N]

STRUCT_ARRAY

List of signals that are allocated to the PCS interface

real_time_data.topic[:].signal[:].allocated_position

(alpha)

[1...N]

INT_1D

Allocation of signal to a position in the SDN (1..N), or several positions in case of signal reshaping; this will be implementation specific

real_time_data.topic[:].signal[:].data_str

(alpha)

[real_time_data.topic[:].time_stamp]

STR_1D

Signal data (e.g. diagnostic signal or PCS command), serialized as a string

real_time_data.topic[:].signal[:].data_type

(alpha)

STR_0D

Signal data type

real_time_data.topic[:].signal[:].name

(alpha)

STR_0D

Signal name

real_time_data.topic[:].signal[:].quality

(alpha)

[real_time_data.topic[:].time_stamp]

INT_1D

Indicator of the quality of the signal. Following ITER PCS documentation (https://user.iter.org/?uid=354SJ3&action=get_document), possible values are: 1 - GOOD (the nominal state); 2 - INVALID (data no usable); 3 - DATA INTEGRITY ERROR (e.g. out of bounds with respect to expectations, calibration error,...)

real_time_data.topic[:].time_stamp

(alpha)

[1...N]

FLT_1D (uncertain)

s

Time of creation for all signals belonging to this topic. A set of time stamps can be recorded if needed