ITER Physics Data Model Documentation for dataset_fair

FAIR metadata related to the dataset, providing inforrmation on licensing, annotations, references using this dataset, versioning and validity, provenance. This IDS is using Dublin Core metadata standard whenever possible

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

Last change occured on version: 3.30.0

Back to top IDS list

By convention, only the upper error node should be filled in case of symmetrical error bars. The upper and lower errors are absolute and defined positive, and represent one standard deviation of the data. The effective values of the data (within one standard deviation) will be within the interval [data-data_error_lower, data+data_error_upper]. Thus whatever the sign of data, data_error_lower relates to the lower bound and data_error_upper to the upper bound of the error bar interval.

Full 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/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/source
Lifecycle status: obsolescent since version 3.34.0
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. {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} struct_array [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)/sources(:) 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. Click here for further documentation. {constant} STR_1D 1- 1...N
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} struct_array [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) struct_array [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) struct_array [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. struct_array [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
identifier Persistent identifier allowing to cite this data in a public and persistent way, should be provided as HTTP URIs {constant} STR_0D
replaces Persistent identifier referencing the previous version of this data {constant} STR_0D
is_replaced_by Persistent identifier referencing the new version of this data (replacing the present version) {constant} STR_0D
valid Date range during which the data is or was valid. Expressed as YYYY-MM-DD/YYYY-MM-DD, where the former (resp. latter) date is the data at which the data started (resp. ceased) to be valid. If the data is still valid, the slash should still be present, i.e. indicate the validity start date with YYYY-MM-DD/. If the data ceased being valid but there is no information on the validity start date, indicate /YYYY-MM-DD. {constant} STR_0D
rights_holder The organisation owning or managing rights over this data {constant} STR_0D
license License(s) under which the data is made available (license description or, more convenient, publicly accessible URL pointing to the full license text) {constant} STR_0D
is_referenced_by(:) List of documents (e.g. publications) or datasets making use of this data entry (e.g. PIDs of other datasets using this data entry as input) {constant} STR_1D 1- 1...N
time(:) Generic time {dynamic} [s] FLT_1D 1- 1...N

Back to top IDS list