dataset descriptionΒΆ
| Path | Dimensions | Type | Units | Description |
|---|---|---|---|---|
dataset_description (alpha) | General description of the dataset (collection of all IDSs within the given database entry). Main description text to be put in ids_properties/comment | |||
dataset_description.data_entry (alpha) | STRUCTURE | Definition of this data entry | ||
dataset_description.data_entry.machine (alpha) | STR_0D | Name of the experimental device to which this data is related | ||
dataset_description.data_entry.pulse (alpha) | INT_0D | Pulse number | ||
dataset_description.data_entry.pulse_type (alpha) | STR_0D | Type of the data entry, e.g. "pulse", "simulation", ... | ||
dataset_description.data_entry.run (alpha) | INT_0D | Run number | ||
dataset_description.data_entry.user (alpha) | STR_0D | Username | ||
dataset_description.dd_version (alpha) | STR_0D | Version of the physics data dictionary of this dataset | ||
dataset_description.ids_properties (alpha) | STRUCTURE | Interface Data Structure properties. This element identifies the node above as an IDS | ||
dataset_description.ids_properties.comment (alpha) | STR_0D | Any comment describing the content of this IDS | ||
dataset_description.ids_properties.creation_date (alpha) | STR_0D | Date at which this data has been produced | ||
dataset_description.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 | ||
dataset_description.ids_properties.name (alpha) | STR_0D | User-defined name for this IDS occurrence | ||
dataset_description.ids_properties.occurrence | INT_0D | |||
dataset_description.ids_properties.occurrence_type (alpha) | STRUCTURE | Type of data contained in this occurrence | ||
dataset_description.ids_properties.occurrence_type.description (alpha) | STR_0D | Verbose description | ||
dataset_description.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. | ||
dataset_description.ids_properties.occurrence_type.name (alpha) | STR_0D | Short string identifier | ||
dataset_description.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. | ||
dataset_description.ids_properties.plugins.infrastructure_get (alpha) | STRUCTURE | Plugin infrastructure used to GET the data | ||
dataset_description.ids_properties.plugins.infrastructure_get.commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_description.ids_properties.plugins.infrastructure_get.description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_description.ids_properties.plugins.infrastructure_get.name (alpha) | STR_0D | Name of software used | ||
dataset_description.ids_properties.plugins.infrastructure_get.repository (alpha) | STR_0D | URL of software repository | ||
dataset_description.ids_properties.plugins.infrastructure_get.version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_description.ids_properties.plugins.infrastructure_put (alpha) | STRUCTURE | Plugin infrastructure used to PUT the data | ||
dataset_description.ids_properties.plugins.infrastructure_put.commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_description.ids_properties.plugins.infrastructure_put.description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_description.ids_properties.plugins.infrastructure_put.name (alpha) | STR_0D | Name of software used | ||
dataset_description.ids_properties.plugins.infrastructure_put.repository (alpha) | STR_0D | URL of software repository | ||
dataset_description.ids_properties.plugins.infrastructure_put.version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_description.ids_properties.plugins.node (alpha) | [1...N] | STRUCT_ARRAY | Set of IDS nodes for which a plugin has been applied | |
dataset_description.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. | |
dataset_description.ids_properties.plugins.node[:].get_operation[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_description.ids_properties.plugins.node[:].get_operation[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_description.ids_properties.plugins.node[:].get_operation[:].name (alpha) | STR_0D | Name of software used | ||
dataset_description.ids_properties.plugins.node[:].get_operation[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_description.ids_properties.plugins.node[:].get_operation[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_description.ids_properties.plugins.node[:].get_operation[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_description.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. | ||
dataset_description.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) | |
dataset_description.ids_properties.plugins.node[:].put_operation[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_description.ids_properties.plugins.node[:].put_operation[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_description.ids_properties.plugins.node[:].put_operation[:].name (alpha) | STR_0D | Name of software used | ||
dataset_description.ids_properties.plugins.node[:].put_operation[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_description.ids_properties.plugins.node[:].put_operation[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_description.ids_properties.plugins.node[:].put_operation[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_description.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) | |
dataset_description.ids_properties.plugins.node[:].readback[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_description.ids_properties.plugins.node[:].readback[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_description.ids_properties.plugins.node[:].readback[:].name (alpha) | STR_0D | Name of software used | ||
dataset_description.ids_properties.plugins.node[:].readback[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_description.ids_properties.plugins.node[:].readback[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_description.ids_properties.plugins.node[:].readback[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_description.ids_properties.provenance (alpha) | STRUCTURE | Provenance information about this IDS | ||
dataset_description.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 | |
dataset_description.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. | ||
dataset_description.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. | |
dataset_description.ids_properties.provider (alpha) | STR_0D | Name of the person in charge of producing this data | ||
dataset_description.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. | ||
dataset_description.ids_properties.version_put (alpha) | STRUCTURE | Version of the access layer package used to PUT this IDS | ||
dataset_description.ids_properties.version_put.access_layer (alpha) | STR_0D | Version of Access Layer used to PUT this IDS | ||
dataset_description.ids_properties.version_put.access_layer_language (alpha) | STR_0D | Programming language of the Access Layer high level API used to PUT this IDS | ||
dataset_description.ids_properties.version_put.data_dictionary (alpha) | STR_0D | Version of Data Dictionary used to PUT this IDS | ||
dataset_description.imas_version (alpha) | STR_0D | Version of the IMAS infrastructure used to produce this data entry. Refers to the global IMAS repository which links to versions of every infrastructure tools | ||
dataset_description.parent_entry (alpha) | STRUCTURE | Definition of the parent data entry, if the present data entry has been generated by applying a given workflow to a unique parent entry | ||
dataset_description.parent_entry.machine (alpha) | STR_0D | Name of the experimental device to which this data is related | ||
dataset_description.parent_entry.pulse (alpha) | INT_0D | Pulse number | ||
dataset_description.parent_entry.pulse_type (alpha) | STR_0D | Type of the data entry, e.g. "pulse", "simulation", ... | ||
dataset_description.parent_entry.run (alpha) | INT_0D | Run number | ||
dataset_description.parent_entry.user (alpha) | STR_0D | Username | ||
dataset_description.pulse_time_begin (alpha) | STR_0D | Date and time (UTC) at which the pulse started on the experiment, 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 | ||
dataset_description.pulse_time_begin_epoch (alpha) | STRUCTURE | Time at which the pulse started on the experiment, 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 | ||
dataset_description.pulse_time_begin_epoch.nanoseconds (alpha) | INT_0D | Elapsed nanoseconds since the time in seconds indicated above | ||
dataset_description.pulse_time_begin_epoch.seconds (alpha) | INT_0D | Elapsed seconds since the Unix Epoch time (01/01/1970 00:00:00 UTC) | ||
dataset_description.pulse_time_end_epoch (alpha) | STRUCTURE | Time at which the pulse ended on the experiment, 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 | ||
dataset_description.pulse_time_end_epoch.nanoseconds (alpha) | INT_0D | Elapsed nanoseconds since the time in seconds indicated above | ||
dataset_description.pulse_time_end_epoch.seconds (alpha) | INT_0D | Elapsed seconds since the Unix Epoch time (01/01/1970 00:00:00 UTC) | ||
dataset_description.simulation (alpha) | STRUCTURE | Description of the general simulation characteristics, if this data entry has been produced by a simulation. Several nodes describe typical time-dependent simulation with a time evolution as the main loop | ||
dataset_description.simulation.comment_after (alpha) | STR_0D | Comment made at the end of a simulation | ||
dataset_description.simulation.comment_before (alpha) | STR_0D | Comment made when launching a simulation | ||
dataset_description.simulation.time_begin (alpha) | FLT_0D (uncertain) | s | Start time | |
dataset_description.simulation.time_begun (alpha) | STR_0D | UTC | Actual wall-clock time simulation started | |
dataset_description.simulation.time_current (alpha) | FLT_0D (uncertain) | s | Current time of the simulation | |
dataset_description.simulation.time_end (alpha) | FLT_0D (uncertain) | s | Stop time | |
dataset_description.simulation.time_ended (alpha) | STR_0D | UTC | Actual wall-clock time simulation finished | |
dataset_description.simulation.time_restart (alpha) | FLT_0D (uncertain) | s | Time of the last restart done during the simulation | |
dataset_description.simulation.time_step (alpha) | FLT_0D (uncertain) | s | Time interval between main steps, e.g. storage step (if relevant and constant) | |
dataset_description.simulation.workflow (alpha) | STR_0D | Description of the workflow which has been used to produce this data entry (e.g. copy of the Kepler MOML if using Kepler) | ||
dataset_description.time (alpha) | [1...N] | FLT_1D_TYPE | s | Generic time |