dataset fairΒΆ
| Path | Dimensions | Type | Units | Description |
|---|---|---|---|---|
dataset_fair (alpha) | 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 | |||
dataset_fair.identifier (alpha) | STR_0D | Persistent identifier allowing to cite this data in a public and persistent way, should be provided as HTTP URIs | ||
dataset_fair.ids_properties (alpha) | STRUCTURE | Interface Data Structure properties. This element identifies the node above as an IDS | ||
dataset_fair.ids_properties.comment (alpha) | STR_0D | Any comment describing the content of this IDS | ||
dataset_fair.ids_properties.creation_date (alpha) | STR_0D | Date at which this data has been produced | ||
dataset_fair.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_fair.ids_properties.name (alpha) | STR_0D | User-defined name for this IDS occurrence | ||
dataset_fair.ids_properties.occurrence | INT_0D | |||
dataset_fair.ids_properties.occurrence_type (alpha) | STRUCTURE | Type of data contained in this occurrence | ||
dataset_fair.ids_properties.occurrence_type.description (alpha) | STR_0D | Verbose description | ||
dataset_fair.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_fair.ids_properties.occurrence_type.name (alpha) | STR_0D | Short string identifier | ||
dataset_fair.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_fair.ids_properties.plugins.infrastructure_get (alpha) | STRUCTURE | Plugin infrastructure used to GET the data | ||
dataset_fair.ids_properties.plugins.infrastructure_get.commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_fair.ids_properties.plugins.infrastructure_get.description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_fair.ids_properties.plugins.infrastructure_get.name (alpha) | STR_0D | Name of software used | ||
dataset_fair.ids_properties.plugins.infrastructure_get.repository (alpha) | STR_0D | URL of software repository | ||
dataset_fair.ids_properties.plugins.infrastructure_get.version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_fair.ids_properties.plugins.infrastructure_put (alpha) | STRUCTURE | Plugin infrastructure used to PUT the data | ||
dataset_fair.ids_properties.plugins.infrastructure_put.commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_fair.ids_properties.plugins.infrastructure_put.description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_fair.ids_properties.plugins.infrastructure_put.name (alpha) | STR_0D | Name of software used | ||
dataset_fair.ids_properties.plugins.infrastructure_put.repository (alpha) | STR_0D | URL of software repository | ||
dataset_fair.ids_properties.plugins.infrastructure_put.version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_fair.ids_properties.plugins.node (alpha) | [1...N] | STRUCT_ARRAY | Set of IDS nodes for which a plugin has been applied | |
dataset_fair.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_fair.ids_properties.plugins.node[:].get_operation[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_fair.ids_properties.plugins.node[:].get_operation[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_fair.ids_properties.plugins.node[:].get_operation[:].name (alpha) | STR_0D | Name of software used | ||
dataset_fair.ids_properties.plugins.node[:].get_operation[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_fair.ids_properties.plugins.node[:].get_operation[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_fair.ids_properties.plugins.node[:].get_operation[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_fair.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_fair.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_fair.ids_properties.plugins.node[:].put_operation[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_fair.ids_properties.plugins.node[:].put_operation[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_fair.ids_properties.plugins.node[:].put_operation[:].name (alpha) | STR_0D | Name of software used | ||
dataset_fair.ids_properties.plugins.node[:].put_operation[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_fair.ids_properties.plugins.node[:].put_operation[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_fair.ids_properties.plugins.node[:].put_operation[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_fair.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_fair.ids_properties.plugins.node[:].readback[:].commit (alpha) | STR_0D | Unique commit reference of software | ||
dataset_fair.ids_properties.plugins.node[:].readback[:].description (alpha) | STR_0D | Short description of the software (type, purpose) | ||
dataset_fair.ids_properties.plugins.node[:].readback[:].name (alpha) | STR_0D | Name of software used | ||
dataset_fair.ids_properties.plugins.node[:].readback[:].parameters (alpha) | STR_0D | List of the code specific parameters in XML format | ||
dataset_fair.ids_properties.plugins.node[:].readback[:].repository (alpha) | STR_0D | URL of software repository | ||
dataset_fair.ids_properties.plugins.node[:].readback[:].version (alpha) | STR_0D | Unique version (tag) of software | ||
dataset_fair.ids_properties.provenance (alpha) | STRUCTURE | Provenance information about this IDS | ||
dataset_fair.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_fair.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_fair.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_fair.ids_properties.provider (alpha) | STR_0D | Name of the person in charge of producing this data | ||
dataset_fair.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_fair.ids_properties.version_put (alpha) | STRUCTURE | Version of the access layer package used to PUT this IDS | ||
dataset_fair.ids_properties.version_put.access_layer (alpha) | STR_0D | Version of Access Layer used to PUT this IDS | ||
dataset_fair.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_fair.ids_properties.version_put.data_dictionary (alpha) | STR_0D | Version of Data Dictionary used to PUT this IDS | ||
dataset_fair.is_referenced_by (alpha) | [1...N] | STR_1D | 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) | |
dataset_fair.is_replaced_by (alpha) | STR_0D | Persistent identifier referencing the new version of this data (replacing the present version) | ||
dataset_fair.license (alpha) | STR_0D | License(s) under which the data is made available (license description or, more convenient, publicly accessible URL pointing to the full license text) | ||
dataset_fair.replaces (alpha) | STR_0D | Persistent identifier referencing the previous version of this data | ||
dataset_fair.rights_holder (alpha) | STR_0D | The organisation owning or managing rights over this data | ||
dataset_fair.time (alpha) | [1...N] | FLT_1D_TYPE | s | Generic time |
dataset_fair.valid (alpha) | STR_0D | 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. |