ITER Physics Data Model Documentation for dataset_description
General description of the dataset (collection of all IDSs within the given database entry). Main description text to be put in ids_properties/comment
Notation of array of structure indices: itime indicates a time index; i1, i2, i3, ... indicate other indices with their depth in the IDS. This notation clarifies the path of a given node, but should not be used to compare indices of different nodes (they may have different meanings).
Lifecycle status: alpha since version 3.0.4
Last change occured on version: 3.30.0
You are now in flat display mode, note that errorbars are not visible in this modeFull path name | Description | Data Type | Coordinates | |||||||||||||||
ids_properties | Interface Data Structure properties. This element identifies the node above as an IDS | structure | ||||||||||||||||
ids_properties/comment | Any comment describing the content of this IDS {constant} | STR_0D | ||||||||||||||||
ids_properties/name | User-defined name for this IDS occurrence {constant}. Introduced after DD version 3.39.0 | STR_0D | ||||||||||||||||
ids_properties/homogeneous_time | 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 {constant} | INT_0D | ||||||||||||||||
ids_properties/occurrence_type | Type of data contained in this occurrence. Introduced after DD version 3.39.0. Available options (refer to the children of this identifier structure) :
|
structure | ||||||||||||||||
ids_properties/occurrence_type/name | Short string identifier {constant} | STR_0D | ||||||||||||||||
ids_properties/occurrence_type/index | Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index. {constant} | INT_0D | ||||||||||||||||
ids_properties/occurrence_type/description | Verbose description {constant} | STR_0D | ||||||||||||||||
ids_properties/provider | Name of the person in charge of producing this data {constant} | STR_0D | ||||||||||||||||
ids_properties/creation_date | Date at which this data has been produced {constant} | STR_0D | ||||||||||||||||
ids_properties/version_put | Version of the access layer package used to PUT this IDS | structure | ||||||||||||||||
ids_properties/version_put/data_dictionary | Version of Data Dictionary used to PUT this IDS {constant} | STR_0D | ||||||||||||||||
ids_properties/version_put/access_layer | Version of Access Layer used to PUT this IDS {constant} | STR_0D | ||||||||||||||||
ids_properties/version_put/access_layer_language | Programming language of the Access Layer high level API used to PUT this IDS {constant} | STR_0D | ||||||||||||||||
ids_properties/provenance Lifecycle status: alpha since version 3.34.0 |
Provenance information about this IDS | structure | ||||||||||||||||
ids_properties/provenance/node(i1) | 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 {constant} | array of structures [max_size=20 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/provenance/node(i1)/path | 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. Click here for further documentation. {constant} | STR_0D | ||||||||||||||||
ids_properties/provenance/node(i1)/reference(i2) | List of references used to populate or calculate this node, identified as explained below. In case the node is the result of of a calculation / data processing, the reference is an input to the process described in the "code" structure at the root of the IDS. The reference 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 reference, or the persistent identifier of the data reference). 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 references. Click here for further documentation.. Introduced after DD version 3.41.0 | array of structures [max_size=10 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/provenance/node(i1)/reference(i2)/name | Reference name {constant} | STR_0D | ||||||||||||||||
ids_properties/provenance/node(i1)/reference(i2)/timestamp | Date and time (UTC) at which the reference was created, expressed in a human readable form (ISO 8601) : the format of the string shall be : YYYY-MM-DDTHH:MM:SSZ. Example : 2020-07-24T14:19:00Z {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins Lifecycle status: alpha since version 3.39.0 |
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.. Introduced after DD version 3.38.1 | structure | ||||||||||||||||
ids_properties/plugins/node(i1) | Set of IDS nodes for which a plugin has been applied {constant} | array of structures [max_size=20 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/plugins/node(i1)/path | 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. Click here for further documentation. {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2) | Plugins used to PUT a node (potentially, multiple plugins can be applied, if so they are listed by order of application) | array of structures [max_size=10 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/name | Name of software used {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/put_operation(i2)/parameters | List of the code specific parameters in XML format {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2) | Plugins to be used to read back a node (potentially, multiple plugins can be applied, listed in reverse order of application) | array of structures [max_size=10 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/name | Name of software used {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/readback(i2)/parameters | List of the code specific parameters in XML format {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2) | 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. | array of structures [max_size=10 (limited in MDS+ backend only)] | 1- 1...N |
|||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/name | Name of software used {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/node(i1)/get_operation(i2)/parameters | List of the code specific parameters in XML format {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_put | Plugin infrastructure used to PUT the data | structure | ||||||||||||||||
ids_properties/plugins/infrastructure_put/name | Name of software used {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_put/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_put/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_put/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_put/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_get | Plugin infrastructure used to GET the data | structure | ||||||||||||||||
ids_properties/plugins/infrastructure_get/name | Name of software used {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_get/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_get/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_get/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
ids_properties/plugins/infrastructure_get/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
uri | IMAS URI of the dataset Click here for further documentation. {constant} | STR_0D | ||||||||||||||||
type | Type of data contained in the dataset. Available options (refer to the children of this identifier structure) :
|
structure | ||||||||||||||||
type/name | Short string identifier {constant} | STR_0D | ||||||||||||||||
type/index | Integer identifier (enumeration index within a list). Private identifier values must be indicated by a negative index. {constant} | INT_0D | ||||||||||||||||
type/description | Verbose description {constant} | STR_0D | ||||||||||||||||
machine | Name of the experimental device to which this data is related (if relevant) {constant} | STR_0D | ||||||||||||||||
pulse | Pulse number to which this data is related (if relevant) {constant} | INT_0D | ||||||||||||||||
pulse_time_begin | Date and time (UTC) at which the pulse started on the experiment (if relevant), expressed in a human readable form (ISO 8601) : the format of the string shall be : YYYY-MM-DDTHH:MM:SSZ. Example : 2020-07-24T14:19:00Z {constant} | STR_0D | ||||||||||||||||
pulse_time_begin_epoch | Time at which the pulse started on the experiment (if relevant), expressed in Unix Epoch time. Temporarily represented as two integers, since for the moment IMAS is missing 64bits long integers to represent epoch time with nanoseconds resolution | structure | ||||||||||||||||
pulse_time_begin_epoch/seconds | Elapsed seconds since the Unix Epoch time (01/01/1970 00:00:00 UTC) {constant} | INT_0D | ||||||||||||||||
pulse_time_begin_epoch/nanoseconds | Elapsed nanoseconds since the time in seconds indicated above {constant} | INT_0D | ||||||||||||||||
pulse_time_end_epoch | Time at which the pulse ended on the experiment (if relevant), expressed in Unix Epoch time. Temporarily represented as two integers, since for the moment IMAS is missing 64bits long integers to represent epoch time with nanoseconds resolution | structure | ||||||||||||||||
pulse_time_end_epoch/seconds | Elapsed seconds since the Unix Epoch time (01/01/1970 00:00:00 UTC) {constant} | INT_0D | ||||||||||||||||
pulse_time_end_epoch/nanoseconds | Elapsed nanoseconds since the time in seconds indicated above {constant} | INT_0D | ||||||||||||||||
pulse_processing_time_begin | For experimental processed data, date and time (UTC) at which the pulse data processing started on the experiment (if relevant), expressed in a human readable form (ISO 8601) : the format of the string shall be : YYYY-MM-DDTHH:MM:SSZ. Example : 2020-07-24T14:19:00Z {constant} | STR_0D | ||||||||||||||||
simulation | Description of the general simulation characteristics, if this dataset has been produced by a simulation. Several nodes describe typical time-dependent simulation with a time evolution as the main loop | structure | ||||||||||||||||
simulation/comment_before | Comment made when launching a simulation {constant} | STR_0D | ||||||||||||||||
simulation/comment_after | Comment made at the end of a simulation {constant} | STR_0D | ||||||||||||||||
simulation/time_begin | Start time {constant} [s] | FLT_0D | ||||||||||||||||
simulation/time_step | Time interval between main steps, e.g. storage step (if relevant and constant) {constant} [s] | FLT_0D | ||||||||||||||||
simulation/time_end | Stop time {constant} [s] | FLT_0D | ||||||||||||||||
simulation/time_restart | Time of the last restart done during the simulation {constant} [s] | FLT_0D | ||||||||||||||||
simulation/time_current | Current time of the simulation {constant} [s] | FLT_0D | ||||||||||||||||
simulation/time_begun | Actual wall-clock time simulation started {constant} [UTC] | STR_0D | ||||||||||||||||
simulation/time_ended | Actual wall-clock time simulation finished {constant} [UTC] | STR_0D | ||||||||||||||||
simulation/workflow | Description of the workflow which has been used to produce this data entry (e.g. copy of the Kepler MOML if using Kepler) {constant} | STR_0D | ||||||||||||||||
code | Decription of the code that has produced the dataset | structure | ||||||||||||||||
code/name | Name of software used {constant} | STR_0D | ||||||||||||||||
code/description | Short description of the software (type, purpose) {constant}. Introduced after DD version 3.38.1 | STR_0D | ||||||||||||||||
code/commit | Unique commit reference of software {constant} | STR_0D | ||||||||||||||||
code/version | Unique version (tag) of software {constant} | STR_0D | ||||||||||||||||
code/repository | URL of software repository {constant} | STR_0D | ||||||||||||||||
code/parameters | List of the code specific parameters in XML format {constant} | STR_0D |