diff --git a/oemetadata/v2/v21/build_source/schema_structure.json b/oemetadata/v2/v21/build_source/schema_structure.json index 43f6c6d6..cd8eda8f 100644 --- a/oemetadata/v2/v21/build_source/schema_structure.json +++ b/oemetadata/v2/v21/build_source/schema_structure.json @@ -22,6 +22,12 @@ "moduleEnergySystems": { "$ref": "module_energy_systems.json#" }, + "moduleMeasurementData": { + "$ref": "module_measurement_data.json#" + }, + "moduleDataTransformationSoftware": { + "$ref": "module_software.json#" + }, "datasetLicenses": { "$ref": "licenses_dataset.json#" }, diff --git a/oemetadata/v2/v21/build_source/schemas/general.json b/oemetadata/v2/v21/build_source/schemas/general.json index 0ffc751b..24782c61 100644 --- a/oemetadata/v2/v21/build_source/schemas/general.json +++ b/oemetadata/v2/v21/build_source/schemas/general.json @@ -36,7 +36,7 @@ "null" ], "examples": [ - "example.csv" + "oemetadata_table_example" ], "badge": "Iron", "title": "Name" @@ -53,24 +53,6 @@ "badge": "Silver", "title": "Title" }, - "topics": { - "description": "An array of predefined topics that correspond to the database schemas of the OEP.", - "type": "array", - "items": { - "description": "The topics are used to group the data in the database.", - "type": [ - "string", - "null" - ], - "examples": [ - "model_draft" - ], - "badge": "Bronze", - "title": "Topic" - }, - "badge": "Bronze", - "title": "Topics" - }, "description": { "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.", "type": [ @@ -95,6 +77,24 @@ "badge": "Bronze", "title": "Publication Date", "format": "date" + }, + "topics": { + "description": "An array of predefined topics that correspond to the database schemas of the OEP.", + "type": "array", + "items": { + "description": "The topics are used to group the data in the database.", + "type": [ + "string", + "null" + ], + "examples": [ + "model_draft" + ], + "badge": "Bronze", + "title": "Topic" + }, + "badge": "Bronze", + "title": "Topics" } }, "required": [ diff --git a/oemetadata/v2/v21/build_source/schemas/licenses_dataset.json b/oemetadata/v2/v21/build_source/schemas/licenses_dataset.json index 29791a94..da2d5a70 100644 --- a/oemetadata/v2/v21/build_source/schemas/licenses_dataset.json +++ b/oemetadata/v2/v21/build_source/schemas/licenses_dataset.json @@ -84,10 +84,10 @@ } }, "badge": "Bronze", - "title": "License" + "title": "Dataset License" }, "badge": "Bronze", - "title": "Licenses" + "title": "Dataset Licenses" } } } diff --git a/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json b/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json index b2d8a93a..8acebf7e 100644 --- a/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json +++ b/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json @@ -8,7 +8,7 @@ "type": "object", "properties": { "supplyTechnologies": { - "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy", + "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.", "type": "array", "items": { "type": "object", @@ -22,8 +22,8 @@ "examples": [ "energy transformation" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Supply Technologies Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -34,16 +34,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00020003" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Supply Technologies Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Technologies Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Technologies" }, "storageTechnologies": { "description": "An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use.", @@ -60,8 +60,8 @@ "examples": [ "energy storage technology" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Storage Technologies Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -72,16 +72,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00020366" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Storage Technologies Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Storage Technologies Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Storage Technologies" }, "supplyGrid": { "description": "A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy.", @@ -98,8 +98,8 @@ "examples": [ "supply grid" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Supply Grid Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -110,16 +110,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00000200" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Supply Grid Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Grid Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Grid" }, "finalEnergyCarrier": { "description": "A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation.", @@ -136,8 +136,8 @@ "examples": [ "final energy carrier" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Final Energy Carrier Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -148,16 +148,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00140080" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Final Energy Carrier Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Final Energy Carrier Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Final Energy Carrier" }, "demandSectors": { "description": "An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics.", @@ -174,8 +174,8 @@ "examples": [ "energy demand sector" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Demand Sectors Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -186,16 +186,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00000128" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Demand Sectors Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Demand Sectors Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Demand Sectors" }, "moduleDescription": { "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", @@ -206,12 +206,12 @@ "examples": [ "Example module for an energy system dataset" ], - "badge": "Gold", - "title": "Context Title" + "badge": "Module", + "title": "Energy Systems Module Description" } }, - "badge": "Gold", - "title": "Context" + "badge": "Module", + "title": "Energy Systems Module" } } } diff --git a/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json b/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json new file mode 100644 index 00000000..62776cc5 --- /dev/null +++ b/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json @@ -0,0 +1,93 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json", + "type": "object", + "properties": { + "moduleMeasurementData": { + "description": "An Object that describes the instruments used in the measurement.", + "type": "array", + "items": { + "type": "object", + "properties": { + "instrumentIdentifier": { + "description": "Unique string that identifies the instrument instance.", + "type": [ + "string", + "null" + ], + "examples": [ + "http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922" + ], + "badge": "Module", + "title": "Instrument Identifier" + }, + "instrumentPath": { + "description": "A landing page that the identifier resolves to.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://sms.atmohub.kit.edu/devices/961" + ], + "badge": "Module", + "title": "Instrument Path", + "format": "uri" + }, + "instrumentName": { + "description": "Name by which the instrument instance is known.", + "type": [ + "string", + "null" + ], + "examples": [ + "MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004" + ], + "badge": "Module", + "title": "Instrument Name" + }, + "instrumentOwner": { + "description": "Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument.", + "type": [ + "string", + "null" + ], + "examples": [ + "Karlsruhe Institute of Technology (KIT)" + ], + "badge": "Module", + "title": "Instrument Owner" + }, + "manufacturerName": { + "description": "Full name of the manufacturer.", + "type": [ + "string", + "null" + ], + "examples": [ + "Merck KGaA" + ], + "badge": "Module", + "title": "Manufacturer Name" + }, + "moduleDescription": { + "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", + "type": [ + "string", + "null" + ], + "examples": [ + "Example instrument of PIDINST schema." + ], + "badge": "Module", + "title": "Module Description" + } + }, + "badge": "Module", + "title": "Instrument" + }, + "badge": "Module", + "title": "Measurement Data Module" + } + } +} diff --git a/oemetadata/v2/v21/build_source/schemas/module_software.json b/oemetadata/v2/v21/build_source/schemas/module_software.json new file mode 100644 index 00000000..ebab49f4 --- /dev/null +++ b/oemetadata/v2/v21/build_source/schemas/module_software.json @@ -0,0 +1,92 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_software.json", + "type": "object", + "properties": { + "moduleDataTransformationSoftware": { + "description": "An Object that describes the instruments used in the measurement.", + "type": "array", + "items": { + "type": "object", + "properties": { + "softwareName": { + "description": "Name of the software.", + "type": [ + "string", + "null" + ], + "examples": [ + "open-mastr" + ], + "badge": "Module", + "title": "Software Name" + }, + "softwarePath": { + "description": "A link or identifier to download or access the software.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/OpenEnergyPlatform/open-MaStR" + ], + "badge": "Module", + "title": "Software Path" + }, + "softwareVersion": { + "description": "The version of the software instance.", + "type": [ + "string", + "null" + ], + "examples": [ + "0.17.1" + ], + "badge": "Module", + "title": "Software Version" + }, + "softwareType": { + "description": "Type of software application.", + "type": [ + "string", + "null" + ], + "examples": [ + "Library" + ], + "badge": "Module", + "title": "Software Type (ERSmeta)" + }, + "programmingLanguage": { + "description": "Type of software application.", + "type": [ + "string", + "null" + ], + "examples": [ + "Python" + ], + "badge": "Module", + "title": "Software Type (ERSmeta)" + }, + "moduleDescription": { + "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", + "type": [ + "string", + "null" + ], + "examples": [ + "Example data transformation software." + ], + "badge": "Module", + "title": "Module Description" + } + }, + "badge": "Module", + "title": "Software" + }, + "badge": "Module", + "title": "Data Transformation Software Module" + } + } +} diff --git a/oemetadata/v2/v21/build_source/scripts/create_example.py b/oemetadata/v2/v21/build_source/scripts/create_example.py index 07bd6fd2..2476a3e1 100644 --- a/oemetadata/v2/v21/build_source/scripts/create_example.py +++ b/oemetadata/v2/v21/build_source/scripts/create_example.py @@ -336,4 +336,6 @@ def remove_modules_from_example(module_keys: list): test_oemetadata_schema_should_validate_oemetadata_example(json_data) copy_example_with_modules(EXAMPLE_PATH, EXAMPLE_MODULES_PATH) - remove_modules_from_example(module_keys=["moduleEnergySystems"]) + remove_modules_from_example( + module_keys=["moduleEnergySystems", "moduleMeasurementData"] + ) diff --git a/oemetadata/v2/v21/build_source/scripts/example/fields.json b/oemetadata/v2/v21/build_source/scripts/example/fields.json index 00b325a7..a5efe7f9 100644 --- a/oemetadata/v2/v21/build_source/scripts/example/fields.json +++ b/oemetadata/v2/v21/build_source/scripts/example/fields.json @@ -161,7 +161,7 @@ }, { "name": "comment", - "description": "", + "description": "Comment", "type": "string", "nullable": true, "unit": null, diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index 2f693135..997fdd9e 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -73,6 +73,16 @@ "comment": "Date of metadata creation" } ], + "moduleDataTransformationSoftware": [ + { + "softwareName": "open-mastr", + "softwarePath": "https://github.com/OpenEnergyPlatform/open-MaStR", + "softwareVersion": "0.17.1", + "softwareType": "Library", + "programmingLanguage": "Python", + "moduleDescription": "Example data transformation software." + } + ], "datasetLicenses": [ { "name": "ODbL-1.0", @@ -91,13 +101,13 @@ { "@id": "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv", "path": "example.csv", - "name": "example.csv", + "name": "oemetadata_table_example", "title": "OEMetadata Table Example", + "description": "Example metadata and table used to illustrate the OEMetadata structure and features.", + "publicationDate": "2024-10-15", "topics": [ "model_draft" ], - "description": "Example metadata and table used to illustrate the OEMetadata structure and features.", - "publicationDate": "2024-10-15", "subject": [ { "name": "energy", @@ -348,7 +358,7 @@ }, { "name": "comment", - "description": "", + "description": "Comment", "type": "string", "nullable": true, "unit": null, diff --git a/oemetadata/v2/v21/example_modules.json b/oemetadata/v2/v21/example_modules.json index 500d6c61..42eeb157 100644 --- a/oemetadata/v2/v21/example_modules.json +++ b/oemetadata/v2/v21/example_modules.json @@ -4,9 +4,11 @@ "name": "oep_oemetadata", "title": "OEP OEMetadata Dataset", "description": "A dataset for the OEMetadata examples.", - "topics": [ - "model_draft" - ], + "extent": { + "name": "Europe", + "@id": "https://www.wikidata.org/wiki/Q458" + }, + "referenceDate": "2020-01-01", "languages": [ "en-GB", "de-DE" @@ -104,6 +106,26 @@ ], "moduleDescription": "Example module for an energy system dataset" }, + "moduleMeasurementData": [ + { + "instrumentIdentifier": "http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922", + "instrumentPath": "https://sms.atmohub.kit.edu/devices/961", + "instrumentName": "MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004", + "instrumentOwner": "Karlsruhe Institute of Technology (KIT)", + "manufacturerName": "Merck KGaA", + "moduleDescription": "Example instrument of PIDINST schema." + } + ], + "moduleDataTransformationSoftware": [ + { + "softwareName": "open-mastr", + "softwarePath": "https://github.com/OpenEnergyPlatform/open-MaStR", + "softwareVersion": "0.17.1", + "softwareType": "Library", + "programmingLanguage": "Python", + "moduleDescription": "Example data transformation software." + } + ], "datasetLicenses": [ { "name": "ODbL-1.0", @@ -115,17 +137,20 @@ } ], "review": { - "path": "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "path": "https://openenergyplatform.org/database/", "badge": "Platinum" }, "resources": [ { "@id": "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv", "path": "example.csv", - "name": "example.csv", + "name": "oemetadata_table_example", "title": "OEMetadata Table Example", "description": "Example metadata and table used to illustrate the OEMetadata structure and features.", "publicationDate": "2024-10-15", + "topics": [ + "model_draft" + ], "subject": [ { "name": "energy", @@ -376,7 +401,7 @@ }, { "name": "comment", - "description": "", + "description": "Comment", "type": "string", "nullable": true, "unit": null, @@ -419,7 +444,7 @@ "decimalSeparator": "." }, "review": { - "path": "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "path": "https://openenergyplatform.org/database/", "badge": "Platinum" } } diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md index 150f2d44..a8b85cd8 100644 --- a/oemetadata/v2/v21/metadata_key_description.md +++ b/oemetadata/v2/v21/metadata_key_description.md @@ -32,24 +32,25 @@ If a value is not yet available, use: `ToDo`. ## Overview ### Dataset - General Keys -|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| -|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------|------------------------------------| -| 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) test | test | Platinum | [0..1] | -| 2 | @id | A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact. | [databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/) test | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | -| 3 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | -| 4 | title | A human readable dataset name. | OEP OEMetadata | [dct:title](http://purl.org/dc/terms/title) | Bronze | [0..1] | -| 5 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] | -| 6 | **spatial** | An object that describes a covered area or region of the dataset. | | [oeo:spatial region](http://purl.obolibrary.org/obo/BFO_0000006) | | [0..1] | -| 6.1 | region | The name of the spatial region of the dataset. | Berlin | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Silver | [0..1] | -| 6.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | -| 7 | referenceDate | A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 8 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] | -| 9 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] | -| 10 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] | -| 11 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | - | [*] | -| 11.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | -| 11.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | -| 12 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | | Platinum | [0..1] | +| 2 | @id | A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact. | [databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | +| 3 | path | A unique identifier (URI/UUID/DOI) for the dataset. | [oemetadata_table_template](https://openenergyplatform.org/database/tables/oemetadata_table_template) | [dcat:accessURL](https://www.w3.org/ns/dcat#accessURL) | Bronze | [0..1] | +| 4 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | +| 5 | title | A human readable dataset name. | OEP OEMetadata | [dct:title](http://purl.org/dc/terms/title) | Bronze | [0..1] | +| 6 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] | +| 7 | **spatial** | An object that describes a covered area or region of the dataset. | | [oeo:spatial region](http://purl.obolibrary.org/obo/BFO_0000006) | | [0..1] | +| 7.1 | region | The name of the spatial region of the dataset. | Berlin | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Silver | [0..1] | +| 7.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | +| 8 | referenceDate | A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 9 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] | +| 10 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] | +| 11 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] | +| 12 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | - | [*] | +| 12.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | +| 12.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | +| 13 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | ### Dataset - Project Context Keys |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| @@ -108,9 +109,9 @@ If a value is not yet available, use: `ToDo`. | 2 | path | A unique identifier (URI/UUID/DOI) for the table or file. | [oemetadata_table_template](https://openenergyplatform.org/database/tables/oemetadata_table_template) | [dcat:accessURL](https://www.w3.org/ns/dcat#accessURL) | Bronze | [0..1] | | 3 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | | 4 | title | A human readable resource or table name. | OEMetadata Table | [dct:title](http://purl.org/dc/terms/title) | Silver | [0..1] | -| 5 | topics | An array of predefined topics that correspond to the database schemas of the OEP. | model_draft | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) | Bronze | [*] | -| 6 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | -| 7 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] | +| 5 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | +| 6 | publicationDate | A date of publication of the data. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] | +| 7 | topics | An array of predefined topics that correspond to the database schemas of the OEP. | model_draft | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) | Bronze | [*] | | 8 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] | | 8.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | | 8.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | @@ -235,35 +236,32 @@ If a value is not yet available, use: `ToDo`. ### Dataset - Module - Energy Systems |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------| -| 1 | moduleName | The name of the module | Energy Systems | | Platinum | [0..1] | -| 3 | supplyTechnologies | A supply technology describes how specific technical components and processes are combined to generate or provide energy. | (Solar, Wind, Biomass, Biogas, Geo, ST, other) | [oeo:OEO_00020003 energy transformation](https://openenergyplatform.org/ontology/oeo/OEO_00020003) | Platinum | [0..1] | -| 4 | storageTechnologies | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | (Battery, Kinetic, CA, Pump, Chemical) | [oeo:00020366 energy storage technology](https://openenergyplatform.org/ontology/oeo/OEO_00020366) | Platinum | [0..1] | -| 6 | supplyGrid | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | (electricity, gas, heating) | [oeo:OEO_00000200 supply grid](https://openenergyplatform.org/ontology/oeo/OEO_00000200) | Platinum | [0..1] | -| 2 | finalEnergyCarrier | A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation. | (electricity, heating, gas, fuel, ...) | [oeo:OEO_00140080 final energy carrier](https://openenergyplatform.org/ontology/oeo/OEO_00140080/) | Platinum | [0..1] | -| 5 | demandSectors | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | (building, commercial, households, transport) | [oeo:OEO_00000128 energy demand sector](https://openenergyplatform.org/ontology/oeo/OEO_00000128) | Platinum | [0..1] | -| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] | +| 1 | supplyTechnologies | A supply technology describes how specific technical components and processes are combined to generate or provide energy. | (Solar, Wind, Biomass, Biogas, Geo, ST, other) | [oeo:OEO_00020003 energy transformation](https://openenergyplatform.org/ontology/oeo/OEO_00020003) | Module | [0..1] | +| 2 | storageTechnologies | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | (Battery, Kinetic, CA, Pump, Chemical) | [oeo:00020366 energy storage technology](https://openenergyplatform.org/ontology/oeo/OEO_00020366) | Module | [0..1] | +| 3 | supplyGrid | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | (electricity, gas, heating) | [oeo:OEO_00000200 supply grid](https://openenergyplatform.org/ontology/oeo/OEO_00000200) | Module | [0..1] | +| 4 | finalEnergyCarrier | A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation. | (electricity, heating, gas, fuel, ...) | [oeo:OEO_00140080 final energy carrier](https://openenergyplatform.org/ontology/oeo/OEO_00140080/) | Module | [0..1] | +| 5 | demandSectors | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | (building, commercial, households, transport) | [oeo:OEO_00000128 energy demand sector](https://openenergyplatform.org/ontology/oeo/OEO_00000128) | Module | [0..1] | +| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] | ### Dataset - Module - Measurement Data |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| -| 1 | moduleName | The name of the module WIP | Measurement Data | ? | Platinum | [0..1] | -| 2 | instrumentIdentifier | Unique string that identifies the instrument instance | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | ? | Platinum | [0..1] | -| 3 | instrumentPath | A landing page that the identifier resolves to | https://sms.atmohub.kit.edu/devices/961 | ? | Platinum | [0..1] | -| 5 | instrumentName | Name by which the instrument instance is known | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | ? | Platinum | [0..1] | -| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | ? | Platinum | [0..1] | -| 5 | manufacturerName | Full name of the manufacturer | Merck KGaA | ? | Platinum | [0..1] | -| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDInst. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] | - -### Dataset - Module - Data Transformations & ERSMeta -|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| -|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| -| 1 | moduleName | The name of the module WIP | Data Transformations | | | [0..1] | -| 2 | softwareName | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 3 | softwarePath | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 4 | softwareVersion | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 5 | softwareType | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 6 | programmingLanguage | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | -| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | +| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | | Module | [0..1] | +| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | | Module | [0..1] | +| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | | Module | [0..1] | +| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | | Module | [0..1] | +| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | | Module | [0..1] | +| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDINST schema. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] | + +### Dataset - Module - Data Transformation Software +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|-------------------------------------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | softwareName | Name of the software. | open-mastr | [schema.org:name](https://schema.org/name) | Module | [0..1] | +| 2 | softwarePath | A link or identifier to download or access the software. | https://github.com/OpenEnergyPlatform/open-MaStR | [schema.org:downloadURL](https://schema.org/downloadURL) | Module | [0..1] | +| 3 | softwareVersion | The version of the software instance. | 0.17.1 | [schema.org:softwareVersion](https://schema.org/softwareVersion) | Module | [0..1] | +| 4 | softwareType | Type of software application. | Library | [ersmeta:softwareType](https://nfdi4energy.github.io/ERSmeta/#ersmeta:softwareType) | Module | [0..1] | +| 5 | programmingLanguage | The computer programming language in which the software is written. | Python | [schema.org:programmingLanguage](https://schema.org/programmingLanguage) | Module | [0..1] | +| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example data transformation software. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] | ### Dataset - Module - Transportation Systems |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| diff --git a/oemetadata/v2/v21/metadata_key_details.md b/oemetadata/v2/v21/metadata_key_details.md index aeafdeb9..c05f28dd 100644 --- a/oemetadata/v2/v21/metadata_key_details.md +++ b/oemetadata/v2/v21/metadata_key_details.md @@ -1322,7 +1322,7 @@ If a value is not yet available, use: `ToDo`. | Description | The metadata on the OEP can go through an open peer review process. See the Academy course [Open Peer Review](https://openenergyplatform.github.io/academy/courses/09_peer_review/) for further information. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Resources - Review Keys - path | | | @@ -1331,7 +1331,7 @@ If a value is not yet available, use: `ToDo`. | Description | A link or path to the documented open peer review. | | Example | [open_peer_review/9](https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/9/) | | Ontology Class | [sc:url](https://schema.org/url) | -| Badge | [0..1] | +| Card. | [0..1] | ### Resources - Review Keys - badge | | | @@ -1340,7 +1340,7 @@ If a value is not yet available, use: `ToDo`. | Description | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. | | Example | Platinum | | Ontology Class | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) | -| Badge | [0..1] | +| Card. | [0..1] | ## Dataset - Modules @@ -1352,7 +1352,7 @@ If a value is not yet available, use: `ToDo`. | Description | An Object that describes the main concepts of an energy system. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - supplyTechnologies | | | @@ -1361,7 +1361,7 @@ If a value is not yet available, use: `ToDo`. | Description | A supply technology describes how specific technical components and processes are combined to generate or provide energy. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - storageTechnologies | | | @@ -1370,7 +1370,7 @@ If a value is not yet available, use: `ToDo`. | Description | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - supplyGrid | | | @@ -1379,7 +1379,7 @@ If a value is not yet available, use: `ToDo`. | Description | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - finalEnergyCarrier | | | @@ -1388,7 +1388,7 @@ If a value is not yet available, use: `ToDo`. | Description | An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - demandSectors | | | @@ -1397,7 +1397,7 @@ If a value is not yet available, use: `ToDo`. | Description | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | ### Dataset - Module - Energy Systems - moduleDescription | | | @@ -1406,7 +1406,71 @@ If a value is not yet available, use: `ToDo`. | Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. | | Example | | | Ontology Class | | -| Badge | [0..1] | +| Card. | [0..1] | + + +### Dataset - Module - Measurement Data +| | | +|----------------|-------------------------------------------------------------------| +| Key | **moduleMeasurementData** | +| Description | An Object that describes the instruments used in the measurement. | +| Example | | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - instrumentIdentifier +| | | +|----------------|---------------------------------------------------------------------| +| Key | **instrumentIdentifier** | +| Description | Unique string that identifies the instrument instance. | +| Example | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - instrumentPath +| | | +|----------------|-------------------------------------------------| +| Key | **instrumentPath** | +| Description | A landing page that the identifier resolves to. | +| Example | https://sms.atmohub.kit.edu/devices/961 | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - instrumentName +| | | +|----------------|----------------------------------------------------| +| Key | **instrumentName** | +| Description | Name by which the instrument instance is known. | +| Example | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - instrumentOwner +| | | +|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Key | **instrumentOwner** | +| Description | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | +| Example | Karlsruhe Institute of Technology (KIT) | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - manufacturerName +| | | +|----------------|--------------------------------| +| Key | **manufacturerName** | +| Description | Full name of the manufacturer. | +| Example | Merck KGaA | +| Ontology Class | | +| Card. | [0..1] | + +### Dataset - Module - Measurement Data - moduleDescription +| | | +|----------------|----------------------------------------------------------------------------------------------------------------------------| +| Key | **moduleDescription** | +| Description | A description of the module. It should be usable as summary information for the module that is described by the metadata. | +| Example | | +| Ontology Class | | +| Card. | [0..1] | ### MetaMetadata Keys diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index 9c00855d..78736cda 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -458,7 +458,7 @@ "type": "object", "properties": { "supplyTechnologies": { - "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy", + "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.", "type": "array", "items": { "type": "object", @@ -472,8 +472,8 @@ "examples": [ "energy transformation" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Supply Technologies Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -484,16 +484,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00020003" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Supply Technologies Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Technologies Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Technologies" }, "storageTechnologies": { "description": "An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use.", @@ -510,8 +510,8 @@ "examples": [ "energy storage technology" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Storage Technologies Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -522,16 +522,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00020366" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Storage Technologies Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Storage Technologies Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Storage Technologies" }, "supplyGrid": { "description": "A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy.", @@ -548,8 +548,8 @@ "examples": [ "supply grid" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Supply Grid Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -560,16 +560,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00000200" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Supply Grid Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Grid Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Supply Grid" }, "finalEnergyCarrier": { "description": "A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation.", @@ -586,8 +586,8 @@ "examples": [ "final energy carrier" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Final Energy Carrier Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -598,16 +598,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00140080" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Final Energy Carrier Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Final Energy Carrier Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Final Energy Carrier" }, "demandSectors": { "description": "An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics.", @@ -624,8 +624,8 @@ "examples": [ "energy demand sector" ], - "badge": "Platinum", - "title": "Subject Name" + "badge": "Module", + "title": "Demand Sectors Subject Name" }, "@id": { "description": "A unique identifier (URI/IRI) of the ontology class.", @@ -636,16 +636,16 @@ "examples": [ "https://openenergyplatform.org/ontology/oeo/OEO_00000128" ], - "badge": "Platinum", - "title": "Subject Identifier", + "badge": "Module", + "title": "Demand Sectors Subject Identifier", "format": "uri" } }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Demand Sectors Subject" }, - "badge": "Platinum", - "title": "Subject" + "badge": "Module", + "title": "Demand Sectors" }, "moduleDescription": { "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", @@ -656,12 +656,183 @@ "examples": [ "Example module for an energy system dataset" ], - "badge": "Gold", - "title": "Context Title" + "badge": "Module", + "title": "Energy Systems Module Description" } }, - "badge": "Gold", - "title": "Context" + "badge": "Module", + "title": "Energy Systems Module" + }, + "moduleMeasurementData": { + "description": "An Object that describes the instruments used in the measurement.", + "type": "array", + "items": { + "type": "object", + "properties": { + "instrumentIdentifier": { + "description": "Unique string that identifies the instrument instance.", + "type": [ + "string", + "null" + ], + "examples": [ + "http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922" + ], + "badge": "Module", + "title": "Instrument Identifier" + }, + "instrumentPath": { + "description": "A landing page that the identifier resolves to.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://sms.atmohub.kit.edu/devices/961" + ], + "badge": "Module", + "title": "Instrument Path", + "format": "uri" + }, + "instrumentName": { + "description": "Name by which the instrument instance is known.", + "type": [ + "string", + "null" + ], + "examples": [ + "MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004" + ], + "badge": "Module", + "title": "Instrument Name" + }, + "instrumentOwner": { + "description": "Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument.", + "type": [ + "string", + "null" + ], + "examples": [ + "Karlsruhe Institute of Technology (KIT)" + ], + "badge": "Module", + "title": "Instrument Owner" + }, + "manufacturerName": { + "description": "Full name of the manufacturer.", + "type": [ + "string", + "null" + ], + "examples": [ + "Merck KGaA" + ], + "badge": "Module", + "title": "Manufacturer Name" + }, + "moduleDescription": { + "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", + "type": [ + "string", + "null" + ], + "examples": [ + "Example instrument of PIDINST schema." + ], + "badge": "Module", + "title": "Module Description" + } + }, + "badge": "Module", + "title": "Instrument" + }, + "badge": "Module", + "title": "Measurement Data Module" + }, + "moduleDataTransformationSoftware": { + "description": "An Object that describes the instruments used in the measurement.", + "type": "array", + "items": { + "type": "object", + "properties": { + "softwareName": { + "description": "Name of the software.", + "type": [ + "string", + "null" + ], + "examples": [ + "open-mastr" + ], + "badge": "Module", + "title": "Software Name" + }, + "softwarePath": { + "description": "A link or identifier to download or access the software.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/OpenEnergyPlatform/open-MaStR" + ], + "badge": "Module", + "title": "Software Path" + }, + "softwareVersion": { + "description": "The version of the software instance.", + "type": [ + "string", + "null" + ], + "examples": [ + "0.17.1" + ], + "badge": "Module", + "title": "Software Version" + }, + "softwareType": { + "description": "Type of software application.", + "type": [ + "string", + "null" + ], + "examples": [ + "Library" + ], + "badge": "Module", + "title": "Software Type (ERSmeta)" + }, + "programmingLanguage": { + "description": "Type of software application.", + "type": [ + "string", + "null" + ], + "examples": [ + "Python" + ], + "badge": "Module", + "title": "Software Type (ERSmeta)" + }, + "moduleDescription": { + "description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.", + "type": [ + "string", + "null" + ], + "examples": [ + "Example data transformation software." + ], + "badge": "Module", + "title": "Module Description" + } + }, + "badge": "Module", + "title": "Software" + }, + "badge": "Module", + "title": "Data Transformation Software Module" }, "datasetLicenses": { "description": "An array of objects of licenses under which the described data is provided.", @@ -744,10 +915,10 @@ } }, "badge": "Bronze", - "title": "License" + "title": "Dataset License" }, "badge": "Bronze", - "title": "Licenses" + "title": "Dataset Licenses" }, "review": { "description": "The metadata on the OEP can go through an open peer review process. See the Academy course [Open Peer Review](https://openenergyplatform.github.io/academy/courses/09_peer_review/) for further information.", @@ -823,7 +994,7 @@ "null" ], "examples": [ - "example.csv" + "oemetadata_table_example" ], "badge": "Iron", "title": "Name" @@ -840,24 +1011,6 @@ "badge": "Silver", "title": "Title" }, - "topics": { - "description": "An array of predefined topics that correspond to the database schemas of the OEP.", - "type": "array", - "items": { - "description": "The topics are used to group the data in the database.", - "type": [ - "string", - "null" - ], - "examples": [ - "model_draft" - ], - "badge": "Bronze", - "title": "Topic" - }, - "badge": "Bronze", - "title": "Topics" - }, "description": { "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.", "type": [ @@ -883,6 +1036,24 @@ "title": "Publication Date", "format": "date" }, + "topics": { + "description": "An array of predefined topics that correspond to the database schemas of the OEP.", + "type": "array", + "items": { + "description": "The topics are used to group the data in the database.", + "type": [ + "string", + "null" + ], + "examples": [ + "model_draft" + ], + "badge": "Bronze", + "title": "Topic" + }, + "badge": "Bronze", + "title": "Topics" + }, "subject": { "description": "An array of objects that references to the subjects of the resource in ontology terms.", "type": "array", diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 3f067dec..64d89af3 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -81,6 +81,26 @@ ], "moduleDescription": "" }, + "moduleMeasurementData": [ + { + "instrumentIdentifier": "", + "instrumentPath": "", + "instrumentName": "", + "instrumentOwner": "", + "manufacturerName": "", + "moduleDescription": "" + } + ], + "moduleDataTransformationSoftware": [ + { + "softwareName": "", + "softwarePath": "", + "softwareVersion": "", + "softwareType": "", + "programmingLanguage": "", + "moduleDescription": "" + } + ], "datasetLicenses": [ { "name": "", @@ -101,11 +121,11 @@ "path": "", "name": "", "title": "", + "description": "", + "publicationDate": "", "topics": [ "" ], - "description": "", - "publicationDate": "", "subject": [ { "name": "",