|
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.
|
@@ -105,15 +110,16 @@ If a value is not yet available, use: `ToDo`.
| 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 | 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 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] |
-| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] |
-| 7.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] |
-| 7.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] |
-| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] |
-| 9 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] |
-| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] |
-| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] |
-| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [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] |
+| 9 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] |
+| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] |
+| 10.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] |
+| 10.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] |
+| 10.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [0..1] |
### Resources - Spatial Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
@@ -145,68 +151,6 @@ If a value is not yet available, use: `ToDo`.
| 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | [oeo:time stamp alignment](http://openenergyplatform.org/ontology/oeo/OEO_00140044) | Silver | [0..1] |
| 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | [oeo:aggregation type](https://openenergyplatform.org/ontology/oeo/OEO_00140068/) | Silver | [0..1] |
-### Resources - Module Keys
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|-------------------------------------------|---------------------------------------|----------------------------------------------|------------------------------------|------------------------------------|
-| 1 | **modules** | An objects with domain specific metadata | | | | [0..1] |
-
-### Module - Energy Systems (LH)
-|
#
|
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] |
-
-### Module - Measurement Data (LH)
-|
#
|
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] |
-
-### Module - Data Transformations & ERSMeta (AK)
-|
#
|
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] |
-
-### Module - Transportation Systems (CHK)
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module WIP | Transportation Systems | | | [0..1] |
-| 2 | transportMode | 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 | meansOfTransport | 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 | transportInfrastructure | 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 | dataGenerationMethod | 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 | surveyPopulation | 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 | elementaryUnit | 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] |
-| 8 | spatialUnit | 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] |
-| 9 | 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] |
-
-### Module - Advanced Provenience (AK, JF)
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module WIP | Advanced Provenience | | | [0..1] |
-| 2 | policy | 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 | objectLifeCycleType | 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 | objectTombstoneInformation | 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 | provenanceGraph | 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 | wasGeneratedBy | 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] |
-
### Resources - Sources Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------|------------------------------------|
@@ -282,6 +226,69 @@ If a value is not yet available, use: `ToDo`.
| 1.1 | path | A link or path to the documented open peer review. | [open_peer_review/9](https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/9/) | [sc:url](https://schema.org/url) | [0..1] |
| 1.2 | badge | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. | Platinum | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) | [0..1] |
+
+### Dataset - Module Keys
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|-------------------------------------------|---------------------------------------|----------------------------------------------|------------------------------------|------------------------------------|
+| 1 | **modules** | An objects with domain specific metadata | | | | [0..1] |
+
+
+### Dataset - Module - Energy Systems
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------|
+| 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
|
Semantic Property
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | [dct:identifier](http://purl.org/dc/terms/identifier) | Module | [0..1] |
+| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | [dct:url](http://purl.org/dc/terms/url) | Module | [0..1] |
+| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | [dct:name](http://purl.org/dc/terms/name) | 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) | [sc:owner](https://schema.org/owner) | Module | [0..1] |
+| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | 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 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] |
+
+### Dataset - Module - Transportation Systems
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | moduleName | The name of the module WIP | Transportation Systems | | | [0..1] |
+| 2 | transportMode | 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 | meansOfTransport | 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 | transportInfrastructure | 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 | dataGenerationMethod | 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 | surveyPopulation | 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 | elementaryUnit | 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] |
+| 8 | spatialUnit | 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] |
+| 9 | 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] |
+
+### Dataset - Module - Advanced Provenience
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | moduleName | The name of the module WIP | Advanced Provenience | | | [0..1] |
+| 2 | policy | 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 | objectLifeCycleType | 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 | objectTombstoneInformation | 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 | provenanceGraph | 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 | wasGeneratedBy | 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] |
+
+
### MetaMetadata Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Card.
|
|--------------------------------|----------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------|------------------------------------|
diff --git a/docs/oemetadata/metadata_key_details.md b/docs/oemetadata/metadata_key_details.md
index 5ccd905b..ab2e365b 100644
--- a/docs/oemetadata/metadata_key_details.md
+++ b/docs/oemetadata/metadata_key_details.md
@@ -484,7 +484,7 @@ If a value is not yet available, use: `ToDo`.
| **Badge** | |
| **Card.** | [*] |
-### Resources - @id
+### Resources - General - @id
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | @id |
@@ -494,7 +494,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - path
+### Resources - General - path
| | |
|----------------|----------------------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -504,7 +504,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - name
+### Resources - General - name
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -514,7 +514,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Iron |
| Card. | [1] |
-### Resources - title
+### Resources - General - title
| | |
|----------------|---------------------------------------------|
| Key | title |
@@ -524,7 +524,17 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - description
+### Resource - General - topics
+| | |
+|----------------|-----------------------------------------------------------------------------------|
+| Key | topics |
+| Description | An array of predefined topics that correspond to the database schemas of the OEP. |
+| Example | model_draft |
+| Ontology Class | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) |
+| Badge | Bronze |
+| Card. | [*] |
+
+### Resources - General - description
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------|
| Key | description |
@@ -534,7 +544,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - publicationDate
+### Resources - General - publicationDate
| | |
|----------------|------------------------------------------------------------------------------------------|
| Key | publicationDate |
@@ -544,7 +554,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - subject
+### Resources - General - subject
| | |
|----------------|-------------------------------------------------------------------------------------|
| Key | subject |
@@ -554,7 +564,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - subject (name)
+### Resources - General - subject (name)
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -564,7 +574,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - subject (@id)
+### Resources - General - subject (@id)
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | @id |
@@ -574,7 +584,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - keywords
+### Resources - General - keywords
| | |
|----------------|----------------------------------------------------------------------------------|
| Key | keywords |
@@ -584,7 +594,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [*] |
-### Resources - embargoPeriod
+### Resources - General - embargoPeriod
| | |
|----------------|----------------------------------------------------------------------------------------------------|
| Key | embargoPeriod |
@@ -594,7 +604,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - embargoPeriod (start)
+### Resources - General - embargoPeriod (start)
| | |
|----------------|-------------------------------------------------------------------------------|
| Key | start |
@@ -604,7 +614,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - embargoPeriod (end)
+### Resources - General - embargoPeriod (end)
| | |
|----------------|------------------------------------------------------------------------------|
| Key | end |
@@ -614,7 +624,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - embargoPeriod (isActive)
+### Resources - General - embargoPeriod (isActive)
| | |
|----------------|----------------------------------------------------------------------------------------------------------------------------------|
| Key | isActive |
@@ -624,7 +634,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - spatial
+### Resources - Spatial
| | |
|----------------|-----------------------------------------------------------|
| Key | spatial |
@@ -634,7 +644,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (location)
+### Resources - Spatial - location
| | |
|----------------|---------------------------------------------------|
| Key | location |
@@ -644,7 +654,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (location - address)
+### Resources - Spatial - location (address)
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| Key | address |
@@ -654,7 +664,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (location - @id)
+### Resources - Spatial - location (@id)
| | |
|----------------|-----------------------------------------------------------------------------|
| Key | @id |
@@ -664,7 +674,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - spatial (location - latitude)
+### Resources - Spatial - location (latitude)
| | |
|----------------|-------------------------------------------------|
| Key | latitude |
@@ -674,7 +684,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - spatial (location - longitude)
+### Resources - Spatial - location (longitude)
| | |
|----------------|--------------------------------------------------|
| Key | longitude |
@@ -684,7 +694,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - spatial (extent)
+### Resources - Spatial - extent
| | |
|----------------|------------------------------------------------------------------|
| Key | extent |
@@ -694,7 +704,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - spatial (extent - name)
+### Resources - Spatial - extent (name)
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -704,7 +714,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - @id)
+### Resources - Spatial - extent (@id)
| | |
|----------------|----------------------------------------------------------------|
| Key | @id |
@@ -714,7 +724,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |
-### Resources - spatial (extent - resolutionValue)
+### Resources - Spatial - extent (resolutionValue)
| | |
|----------------|---------------------------------------------------------------------------------------|
| Key | resolutionValue |
@@ -724,7 +734,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - resolutionUnit)
+### Resources - Spatial - extent (resolutionUnit)
| | |
|----------------|---------------------------------------------------------------------|
| Key | resolutionUnit |
@@ -734,7 +744,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - spatial (extent - boundingBox)
+### Resources - Spatial - extent (boundingBox)
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------------|
| Key | boundingBox |
@@ -744,7 +754,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [*] |
-### Resources - spatial (extent - crs)
+### Resources - Spatial - extent (crs)
| | |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| Key | crs |
@@ -754,7 +764,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Gold |
| Card. | [0..1] |
-### Resources - temporal
+### Resources - Temporal
| | |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | temporal |
@@ -764,7 +774,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [0..1] |
-### Resources - temporal (referenceDate)
+### Resources - Temporal - referenceDate
| | |
|----------------|-----------------------------------------------------------------------------------------------------|
| Key | referenceDate |
@@ -774,7 +784,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries)
+### Resources - Temporal - timeseries
| | |
|----------------|-----------------------------------------------------------|
| Key | timeseries |
@@ -784,7 +794,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - temporal (timeseries - start)
+### Resources - Temporal - timeseries (start)
| | |
|----------------|-----------------------------------------------------------------|
| Key | start |
@@ -794,7 +804,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - end)
+### Resources - Temporal - timeseries (end)
| | |
|----------------|-------------------------------------------------------------|
| Key | end |
@@ -804,7 +814,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - resolutionValue)
+### Resources - Temporal - timeseries (resolutionValue)
| | |
|----------------|----------------------------------------------------------------------------------------------------|
| Key | resolutionValue |
@@ -814,7 +824,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - resolutionUnit)
+### Resources - Temporal - timeseries (resolutionUnit)
| | |
|----------------|---------------------------------------------------------------------|
| Key | resolutionUnit |
@@ -824,7 +834,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - alignment)
+### Resources - Temporal - timeseries (alignment)
| | |
|----------------|----------------------------------------------------------------------------------------------|
| Key | alignment |
@@ -834,7 +844,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |
-### Resources - temporal (timeseries - aggregationType)
+### Resources - Temporal - timeseries (aggregationType)
| | |
|----------------|-----------------------------------------------------------------------------------|
| Key | aggregationType |
@@ -856,7 +866,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - sources (title)
+### Resources - sources - title
| | |
|----------------|------------------------------------------------------------------------------|
| Key | title |
@@ -866,7 +876,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (authors)
+### Resources - sources - authors
| | |
|----------------|-------------------------------------------------------------------------|
| Key | authors |
@@ -876,7 +886,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [*] |
-### Resources - sources (description)
+### Resources - sources - description
| | |
|----------------|-----------------------------------------------------------|
| Key | description |
@@ -886,7 +896,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (publicationYear)
+### Resources - sources - publicationYear
| | |
|----------------|-------------------------------------------------|
| Key | publicationYear |
@@ -896,7 +906,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - sources (path)
+### Resources - sources - path
| | |
|----------------|----------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -986,7 +996,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | |
| Card. | [*] |
-### Resources - resourceLicenses (name)
+### Resources - resourceLicenses - name
| | |
|----------------|------------------------------------------------------------|
| Key | name |
@@ -996,7 +1006,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (title)
+### Resources - resourceLicenses - title
| | |
|----------------|-----------------------------------------------------|
| Key | title |
@@ -1006,7 +1016,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (path)
+### Resources - resourceLicenses - path
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | path |
@@ -1016,7 +1026,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (instruction)
+### Resources - resourceLicenses - instruction
| | |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | instruction |
@@ -1026,7 +1036,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (attribution)
+### Resources - resourceLicenses - attribution
| | |
|----------------|---------------------------------------------------------------------------------------|
| Key | attribution |
@@ -1036,7 +1046,7 @@ If a value is not yet available, use: `ToDo`.
| Badge | Bronze |
| Card. | [0..1] |
-### Resources - resourceLicenses (copyrightStatement)
+### Resources - resourceLicenses - copyrightStatement
| | |
|----------------|---------------------------------------------------------------------------------------------------------------------|
| Key | copyrightStatement |
@@ -1312,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
| | |
@@ -1321,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
| | |
@@ -1330,7 +1340,138 @@ 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
+
+### Dataset - Module - Energy Systems
+| | |
+|----------------|------------------------------------------------------------------|
+| Key | **moduleEnergySystems** |
+| Description | An Object that describes the main concepts of an energy system. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - supplyTechnologies
+| | |
+|----------------|----------------------------------------------------------------------------------------------------------------------------|
+| Key | **supplyTechnologies** |
+| Description | A supply technology describes how specific technical components and processes are combined to generate or provide energy. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - storageTechnologies
+| | |
+|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **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. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - supplyGrid
+| | |
+|----------------|---------------------------------------------------------------------------------------------------------------------------------|
+| Key | **supplyGrid** |
+| Description | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - finalEnergyCarrier
+| | |
+|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **finalEnergyCarrier** |
+| 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 | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - demandSectors
+| | |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **demandSectors** |
+| Description | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - 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] |
+
+
+### 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 | [dct:identifier](http://purl.org/dc/terms/identifier) |
+| 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 | [dct:url](http://purl.org/dc/terms/url) |
+| 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 | [dct:name](http://purl.org/dc/terms/name) |
+| 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 | [sc:owner](https://schema.org/owner) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - manufacturerName
+| | |
+|----------------|-----------------------------------------------------|
+| Key | **manufacturerName** |
+| Description | Full name of the manufacturer. |
+| Example | Merck KGaA |
+| Ontology Class | [sc:manufacturer](https://schema.org/manufacturer) |
+| 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 | Example instrument of PIDINST schema. |
+| Ontology Class | [dct:description](http://purl.org/dc/terms/description) |
+| Card. | [0..1] |
+
### MetaMetadata Keys
| | |
@@ -1339,7 +1480,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An object that describes the metadata themselves, their format, version and license. |
| Example | |
| Ontology Class | |
-| Card. | [1] |
+| Card. | [0..1] |
### MetaMetadata Keys - metadataVersion
| | |
diff --git a/oemetadata/v2/v21/build_source/schema_structure.json b/oemetadata/v2/v21/build_source/schema_structure.json
index 1cf3e828..5e4e53b1 100644
--- a/oemetadata/v2/v21/build_source/schema_structure.json
+++ b/oemetadata/v2/v21/build_source/schema_structure.json
@@ -19,6 +19,12 @@
"provenance": {
"$ref": "provenance.json#"
},
+ "moduleEnergySystems": {
+ "$ref": "module_energy_systems.json#"
+ },
+ "moduleMeasurementData": {
+ "$ref": "module_measurement_data.json#"
+ },
"datasetLicenses": {
"$ref": "licenses_dataset.json#"
},
diff --git a/oemetadata/v2/v21/build_source/schemas/context.json b/oemetadata/v2/v21/build_source/schemas/context.json
deleted file mode 100644
index ac5c3f8a..00000000
--- a/oemetadata/v2/v21/build_source/schemas/context.json
+++ /dev/null
@@ -1,139 +0,0 @@
-{
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/context.json",
- "type": "object",
- "properties": {
- "context": {
- "description": "An Object that describes the general setting, environment or project leading to the creation or maintenance of this dataset. In science this can be the research project.",
- "type": "object",
- "properties": {
- "title": {
- "description": "A title of the associated project.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "NFDI4Energy"
- ],
- "badge": "Gold",
- "title": "Context Title"
- },
- "homepage": {
- "description": "A URL of the project.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "https://nfdi4energy.uol.de/"
- ],
- "badge": "Gold",
- "title": "Homepage",
- "format": "uri"
- },
- "documentation": {
- "description": "A URL of the project documentation.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "https://nfdi4energy.uol.de/sites/about_us/"
- ],
- "badge": "Gold",
- "title": "Documentation"
- },
- "sourceCode": {
- "description": "A URL of the source code of the project.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "https://github.com/NFDI4Energy"
- ],
- "badge": "Gold",
- "title": "Source Code"
- },
- "publisher": {
- "description": "The publishing agency of the data. This can be the OEP.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "Open Energy Platform (OEP)"
- ],
- "badge": "Bronze",
- "title": "Publisher"
- },
- "publisherLogo": {
- "description": "A URL to the logo of the publishing agency of data.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "https://github.com/OpenEnergyPlatform/organisation/blob/production/logo/OpenEnergyFamily_Logo_OpenEnergyPlatform.svg"
- ],
- "badge": "Gold",
- "title": "Publisher Logo",
- "format": "uri"
- },
- "contact": {
- "description": "A reference to the creator or maintainer of the data set. This can be an email address or a GitHub handle.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "contact@example.com"
- ],
- "badge": "Gold",
- "title": "E-Mail Contact",
- "format": "email"
- },
- "fundingAgency": {
- "description": "A name of the entity providing the funding. This can be a government agency or a company.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- " Deutsche Forschungsgemeinschaft (DFG)"
- ],
- "badge": "Gold",
- "title": "Funding Agency"
- },
- "fundingAgencyLogo": {
- "description": "A URL to the logo or image of the funding agency.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "https://upload.wikimedia.org/wikipedia/commons/8/86/DFG-logo-blau.svg"
- ],
- "badge": "Gold",
- "title": "Funding Agency Logo",
- "format": "uri"
- },
- "grantNo": {
- "description": "An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency.",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "501865131"
- ],
- "badge": "Gold",
- "title": "Grant Number"
- }
- },
- "badge": "Gold",
- "title": "Context"
- }
- }
-}
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
new file mode 100644
index 00000000..8acebf7e
--- /dev/null
+++ b/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json
@@ -0,0 +1,217 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json",
+ "type": "object",
+ "properties": {
+ "moduleEnergySystems": {
+ "description": "An Object that describes the main concepts of an energy system.",
+ "type": "object",
+ "properties": {
+ "supplyTechnologies": {
+ "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy transformation"
+ ],
+ "badge": "Module",
+ "title": "Supply Technologies Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00020003"
+ ],
+ "badge": "Module",
+ "title": "Supply Technologies Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Supply Technologies 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy storage technology"
+ ],
+ "badge": "Module",
+ "title": "Storage Technologies Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00020366"
+ ],
+ "badge": "Module",
+ "title": "Storage Technologies Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Storage Technologies 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "supply grid"
+ ],
+ "badge": "Module",
+ "title": "Supply Grid Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00000200"
+ ],
+ "badge": "Module",
+ "title": "Supply Grid Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Supply Grid 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "final energy carrier"
+ ],
+ "badge": "Module",
+ "title": "Final Energy Carrier Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00140080"
+ ],
+ "badge": "Module",
+ "title": "Final Energy Carrier Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Final Energy Carrier 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy demand sector"
+ ],
+ "badge": "Module",
+ "title": "Demand Sectors Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00000128"
+ ],
+ "badge": "Module",
+ "title": "Demand Sectors Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Demand Sectors 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.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "Example module for an energy system dataset"
+ ],
+ "badge": "Module",
+ "title": "Energy Systems Module Description"
+ }
+ },
+ "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..2294956b
--- /dev/null
+++ b/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json
@@ -0,0 +1,90 @@
+{
+ "$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",
+ "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/scripts/create_example.py b/oemetadata/v2/v21/build_source/scripts/create_example.py
index 75aa9e04..2476a3e1 100644
--- a/oemetadata/v2/v21/build_source/scripts/create_example.py
+++ b/oemetadata/v2/v21/build_source/scripts/create_example.py
@@ -22,6 +22,7 @@
from typing import Any, Dict, List, Union
from settings import (
+ EXAMPLE_MODULES_PATH,
EXAMPLE_PATH,
LOG_FORMAT,
RESOLVED_SCHEMA_FILE_NAME,
@@ -265,6 +266,63 @@ def replace_key_in_json(file_path, target_key, new_value):
logger.info(f"Key '{target_key}' not found in JSON file.")
+def copy_example_with_modules(source_path, target_path):
+ """
+ Copies a JSON example file and removes specified module/section keys from the copy.
+
+ Args:
+ source_path: Path to the source example.json
+ target_path: Path for the output example_module.json
+ """
+ with open(source_path, encoding="utf-8") as file:
+ data = json.load(file)
+
+ with open(target_path, "w", encoding="utf-8") as file:
+ json.dump(data, file, ensure_ascii=False, indent=2)
+ file.write("\n")
+
+ logger.info(f"Copied '{source_path}' to '{target_path}'")
+
+
+def remove_keys_from_json(data, keys_to_remove: list):
+ """
+ Recursively removes all occurrences of the given keys from a JSON structure.
+
+ Args:
+ data: The JSON data (dict or list)
+ keys_to_remove: List of keys to remove
+ """
+ if isinstance(data, dict):
+ for key in keys_to_remove:
+ if key in data:
+ del data[key]
+ logger.info(f"Removed keys: '{key}'")
+ for value in data.values():
+ remove_keys_from_json(value, keys_to_remove)
+ elif isinstance(data, list):
+ for item in data:
+ remove_keys_from_json(item, keys_to_remove)
+
+
+def remove_modules_from_example(module_keys: list):
+ """
+ Copies a JSON example file and removes specified module/section keys from the copy.
+
+ Args:
+ module_keys: List of top-level (or nested) keys to remove from the copy
+ """
+ with open(EXAMPLE_PATH, encoding="utf-8") as file:
+ data = json.load(file)
+
+ remove_keys_from_json(data, module_keys)
+
+ with open(EXAMPLE_PATH, "w", encoding="utf-8") as file:
+ json.dump(data, file, ensure_ascii=False, indent=2)
+ file.write("\n")
+
+ logger.info(f"Removed modules: {module_keys}")
+
+
if __name__ == "__main__":
logger.info("Create OEMetadata Example from Schema.")
schema_filename = RESOLVED_SCHEMA_FILE_NAME
@@ -276,3 +334,8 @@ def replace_key_in_json(file_path, target_key, new_value):
example_contributors = read_schema(SCHEMA_EXAMPLE_PROV)
replace_key_in_json(EXAMPLE_PATH, "contributors", example_contributors)
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", "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/build_source/scripts/settings.py b/oemetadata/v2/v21/build_source/scripts/settings.py
index e9745f63..393e909c 100644
--- a/oemetadata/v2/v21/build_source/scripts/settings.py
+++ b/oemetadata/v2/v21/build_source/scripts/settings.py
@@ -20,5 +20,6 @@
EXPECTED_SCHEMA_PATH = VERSION_PATH / "schema.json"
EXAMPLE_PATH = VERSION_PATH / "example.json"
+EXAMPLE_MODULES_PATH = VERSION_PATH / "example_modules.json"
TEMPLATE_PATH = VERSION_PATH / "template.json"
LATEST_PATH = Path("oemetadata/latest/")
diff --git a/oemetadata/v2/v21/context.json b/oemetadata/v2/v21/context.json
index 39f98470..75b7429b 100644
--- a/oemetadata/v2/v21/context.json
+++ b/oemetadata/v2/v21/context.json
@@ -322,6 +322,30 @@
"@id": "oeo:OEO_00140098",
"@type": "xsd:string"
},
+ "moduleMeasurementData": {
+ "@container": "@set",
+ "@id": "dcat:hasPart"
+ },
+ "instrumentIdentifier": {
+ "@id": "dct:identifier",
+ "@type": "@id"
+ },
+ "instrumentPath": {
+ "@id": "dct:url",
+ "@type": "xsd:string"
+ },
+ "instrumentName": {
+ "@id": "dct:name",
+ "@type": "xsd:string"
+ },
+ "instrumentOwner": {
+ "@id": "sc:owner",
+ "@type": "xsd:string"
+ },
+ "manufacturerName": {
+ "@id": "sc:manufacturer",
+ "@type": "xsd:string"
+ },
"metaMetadata": "@nest",
"metadataVersion": {
"@id": "owl:versionInfo",
diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json
index 2f693135..975402bc 100644
--- a/oemetadata/v2/v21/example.json
+++ b/oemetadata/v2/v21/example.json
@@ -91,13 +91,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 +348,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
new file mode 100644
index 00000000..bd7b992d
--- /dev/null
+++ b/oemetadata/v2/v21/example_modules.json
@@ -0,0 +1,450 @@
+{
+ "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json",
+ "@id": "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/",
+ "name": "oep_oemetadata",
+ "title": "OEP OEMetadata Dataset",
+ "description": "A dataset for the OEMetadata examples.",
+ "extent": {
+ "name": "Europe",
+ "@id": "https://www.wikidata.org/wiki/Q458"
+ },
+ "referenceDate": "2020-01-01",
+ "languages": [
+ "en-GB",
+ "de-DE"
+ ],
+ "version": "0.1.0",
+ "image": "https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png",
+ "subject": [
+ {
+ "name": "energy",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000150"
+ }
+ ],
+ "keywords": [
+ "example",
+ "ODbL-1.0",
+ "NFDI4Energy"
+ ],
+ "projectContext": {
+ "title": "NFDI4Energy",
+ "homepage": "https://nfdi4energy.uol.de/",
+ "documentation": "https://nfdi4energy.uol.de/sites/about_us/",
+ "sourceCode": "https://github.com/NFDI4Energy",
+ "publisher": "Open Energy Platform (OEP)",
+ "publisherLogo": "https://github.com/OpenEnergyPlatform/organisation/blob/production/logo/OpenEnergyFamily_Logo_OpenEnergyPlatform.svg",
+ "contact": "contact@example.com",
+ "fundingAgency": " Deutsche Forschungsgemeinschaft (DFG)",
+ "fundingAgencyLogo": "https://upload.wikimedia.org/wikipedia/commons/8/86/DFG-logo-blau.svg",
+ "grantNo": "501865131"
+ },
+ "contributors": [
+ {
+ "title": "Ludwig Hülk",
+ "path": "https://github.com/Ludee",
+ "organization": "Reiner Lemoine Institut",
+ "roles": [
+ "Creator"
+ ],
+ "date": "2026-04-09",
+ "object": "dataset",
+ "comment": "Date of dataset creation"
+ },
+ {
+ "title": "Ludwig Hülk",
+ "path": "https://github.com/Ludee",
+ "organization": "Reiner Lemoine Institut",
+ "roles": [
+ "DataCollector"
+ ],
+ "date": "2024-11-19",
+ "object": "data",
+ "comment": "Date of data creation"
+ },
+ {
+ "title": "Ludwig Hülk",
+ "path": "https://github.com/Ludee",
+ "organization": "Reiner Lemoine Institut",
+ "roles": [
+ "DataCurator"
+ ],
+ "date": "2024-11-30",
+ "object": "metadata",
+ "comment": "Date of metadata creation"
+ }
+ ],
+ "moduleEnergySystems": {
+ "supplyTechnologies": [
+ {
+ "name": "energy transformation",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00020003"
+ }
+ ],
+ "storageTechnologies": [
+ {
+ "name": "energy storage technology",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00020366"
+ }
+ ],
+ "supplyGrid": [
+ {
+ "name": "supply grid",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000200"
+ }
+ ],
+ "finalEnergyCarrier": [
+ {
+ "name": "final energy carrier",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00140080"
+ }
+ ],
+ "demandSectors": [
+ {
+ "name": "energy demand sector",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000128"
+ }
+ ],
+ "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."
+ }
+ ],
+ "datasetLicenses": [
+ {
+ "name": "ODbL-1.0",
+ "title": "Open Data Commons Open Database License 1.0",
+ "path": "https://opendatacommons.org/licenses/odbl/1-0/index.html",
+ "instruction": "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information.",
+ "attribution": "© Reiner Lemoine Institut",
+ "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt"
+ }
+ ],
+ "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": "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",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000150"
+ }
+ ],
+ "keywords": [
+ "example",
+ "ODbL-1.0",
+ "NFDI4Energy"
+ ],
+ "embargoPeriod": {
+ "start": "2024-10-11",
+ "end": "2025-01-01",
+ "isActive": true
+ },
+ "spatial": {
+ "location": {
+ "address": "Rudower Chaussee 12, 12489 Berlin",
+ "@id": "https://www.wikidata.org/wiki/Q77077223",
+ "latitude": "52.432822",
+ "longitude": "13.5351004"
+ },
+ "extent": {
+ "name": "Berlin",
+ "@id": "https://www.wikidata.org/wiki/Q64",
+ "resolutionValue": "100",
+ "resolutionUnit": "m",
+ "boundingBox": [
+ 13.08825,
+ 52.33859,
+ 13.76104,
+ 52.6754
+ ],
+ "crs": "EPSG:4326"
+ }
+ },
+ "temporal": {
+ "referenceDate": "2020-01-01",
+ "timeseries": [
+ {
+ "start": "2020-01-01T00:00:00+01:00",
+ "end": "2020-01-01T23:59:30+01:00",
+ "resolutionValue": "15",
+ "resolutionUnit": "min",
+ "alignment": "left",
+ "aggregationType": "current"
+ }
+ ]
+ },
+ "sources": [
+ {
+ "title": "IPCC Sixth Assessment Report (AR6) - Climate Change 2023 - Synthesis Report",
+ "authors": [
+ "Hoesung Lee",
+ "José Romero",
+ "The Core Writing Team"
+ ],
+ "description": "A Report of the Intergovernmental Panel on Climate Change.",
+ "publicationYear": "2023",
+ "path": "https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf",
+ "sourceLicenses": [
+ {
+ "name": "CC-BY-4.0",
+ "title": "Creative Commons Attribution 4.0 International",
+ "path": "https://creativecommons.org/licenses/by/4.0/legalcode",
+ "instruction": "You are free to share and change, but you must attribute. See https://www.tldrlegal.com/license/creative-commons-attribution-4-0-international-cc-by-4 for further information.",
+ "attribution": "© Intergovernmental Panel on Climate Change 2023",
+ "copyrightStatement": "https://www.ipcc.ch/copyright/"
+ }
+ ]
+ }
+ ],
+ "resourceLicenses": [
+ {
+ "name": "ODbL-1.0",
+ "title": "Open Data Commons Open Database License 1.0",
+ "path": "https://opendatacommons.org/licenses/odbl/1-0/index.html",
+ "instruction": "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information.",
+ "attribution": "© Reiner Lemoine Institut",
+ "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt"
+ }
+ ],
+ "type": "table",
+ "format": "csv",
+ "encoding": "UTF-8",
+ "schema": {
+ "fields": [
+ {
+ "name": "id",
+ "description": "Unique identifier",
+ "type": "integer",
+ "nullable": false,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "identifier",
+ "@id": "http://purl.obolibrary.org/obo/IAO_0020000",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ },
+ {
+ "name": "name",
+ "description": "Technology Name",
+ "type": "string",
+ "nullable": true,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "power generation technology",
+ "@id": "http://openenergy-platform.org/ontology/oeo/OEO_00010423",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": "wind",
+ "name": "wind power technology",
+ "@id": "http://openenergyplatform.org/ontology/oeo/OEO_00010424",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ]
+ },
+ {
+ "name": "type",
+ "description": "Type of wind farm",
+ "type": "string",
+ "nullable": true,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "wind farm",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000447/",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": "onshore",
+ "name": "onshore wind farm",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000311/",
+ "mappingRelation": "skos:exactMatch"
+ },
+ {
+ "value": "offshore",
+ "name": "offshore wind farm",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000308/",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ]
+ },
+ {
+ "name": "year",
+ "description": "Reference year",
+ "type": "integer",
+ "nullable": true,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "year",
+ "@id": "https://openenergyplatform.org/ontology/oeo/UO_0000036/",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ },
+ {
+ "name": "value",
+ "description": "Bruttoleistung",
+ "type": "number",
+ "nullable": true,
+ "unit": "MW",
+ "isAbout": [
+ {
+ "name": "nameplate capacity",
+ "@id": "https://openenergyplatform.org/ontology/oeo/OEO_00230003/",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ },
+ {
+ "name": "is_active",
+ "description": "Betriebsstatus",
+ "type": "boolean",
+ "nullable": false,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "Operating Mode Status",
+ "@id": "https://ontology.brickschema.org/brick/Operating_Mode_Status",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ },
+ {
+ "name": "version",
+ "description": "Version",
+ "type": "string",
+ "nullable": true,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "version number",
+ "@id": "http://purl.obolibrary.org/obo/IAO_0000129",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ },
+ {
+ "name": "comment",
+ "description": "Comment",
+ "type": "string",
+ "nullable": true,
+ "unit": null,
+ "isAbout": [
+ {
+ "name": "comment",
+ "@id": "http://semanticscience.org/resource/SIO_001167",
+ "mappingRelation": "skos:exactMatch"
+ }
+ ],
+ "valueReference": [
+ {
+ "value": null,
+ "name": null,
+ "@id": null,
+ "mappingRelation": null
+ }
+ ]
+ }
+ ],
+ "primaryKey": [
+ "id"
+ ],
+ "foreignKeys": [
+ {
+ "fields": [
+ "version"
+ ],
+ "reference": {
+ "resource": "example_version.csv",
+ "fields": [
+ "version"
+ ]
+ }
+ }
+ ]
+ },
+ "dialect": {
+ "delimiter": ";",
+ "decimalSeparator": "."
+ },
+ "review": {
+ "path": "https://openenergyplatform.org/database/",
+ "badge": "Platinum"
+ }
+ }
+ ],
+ "metaMetadata": {
+ "metadataVersion": "OEMetadata-2.1.0",
+ "metadataLicense": {
+ "name": "CC0-1.0",
+ "title": "Creative Commons Zero v1.0 Universal",
+ "path": "https://creativecommons.org/publicdomain/zero/1.0"
+ }
+ }
+}
diff --git a/oemetadata/v2/v21/example_modules.py b/oemetadata/v2/v21/example_modules.py
new file mode 100644
index 00000000..9f91067e
--- /dev/null
+++ b/oemetadata/v2/v21/example_modules.py
@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2026 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: oemetadata
+# SPDX-License-Identifier: MIT
+
+import json
+from pathlib import Path
+
+from frictionless import Package
+
+
+BASE_PATH = Path(__file__).parent
+
+with open(BASE_PATH / "example_modules.json", "rb") as f:
+ descriptor = json.load(f)
+
+OEMETADATA_V21_EXAMPLE_MODULES = Package(descriptor, basepath=str(BASE_PATH))
diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md
index aeecb16a..35c638ed 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] |
@@ -150,68 +151,6 @@ If a value is not yet available, use: `ToDo`.
| 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | [oeo:time stamp alignment](http://openenergyplatform.org/ontology/oeo/OEO_00140044) | Silver | [0..1] |
| 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | [oeo:aggregation type](https://openenergyplatform.org/ontology/oeo/OEO_00140068/) | Silver | [0..1] |
-### Resources - Module Keys
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|-------------------------------------------|---------------------------------------|----------------------------------------------|------------------------------------|------------------------------------|
-| 1 | **modules** | An objects with domain specific metadata | | | | [0..1] |
-
-### Module - Energy Systems (LH)
-|
#
|
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] |
-
-### Module - Measurement Data (LH)
-|
#
|
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] |
-
-### Module - Data Transformations & ERSMeta (AK)
-|
#
|
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] |
-
-### Module - Transportation Systems (CHK)
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module WIP | Transportation Systems | | | [0..1] |
-| 2 | transportMode | 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 | meansOfTransport | 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 | transportInfrastructure | 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 | dataGenerationMethod | 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 | surveyPopulation | 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 | elementaryUnit | 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] |
-| 8 | spatialUnit | 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] |
-| 9 | 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] |
-
-### Module - Advanced Provenience (AK, JF)
-|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
-|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
-| 1 | moduleName | The name of the module WIP | Advanced Provenience | | | [0..1] |
-| 2 | policy | 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 | objectLifeCycleType | 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 | objectTombstoneInformation | 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 | provenanceGraph | 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 | wasGeneratedBy | 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] |
-
### Resources - Sources Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------|------------------------------------|
@@ -287,6 +226,69 @@ If a value is not yet available, use: `ToDo`.
| 1.1 | path | A link or path to the documented open peer review. | [open_peer_review/9](https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/9/) | [sc:url](https://schema.org/url) | [0..1] |
| 1.2 | badge | A badge of either Iron, Bronze, Silver, Gold or Platinum is used to label the quality of the metadata. | Platinum | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) | [0..1] |
+
+### Dataset - Module Keys
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|-------------------------------------------|---------------------------------------|----------------------------------------------|------------------------------------|------------------------------------|
+| 1 | **modules** | An objects with domain specific metadata | | | | [0..1] |
+
+
+### Dataset - Module - Energy Systems
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------|
+| 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
|
Semantic Property
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | [dct:identifier](http://purl.org/dc/terms/identifier) | Module | [0..1] |
+| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | [dct:url](http://purl.org/dc/terms/url) | Module | [0..1] |
+| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | [dct:name](http://purl.org/dc/terms/name) | 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) | [sc:owner](https://schema.org/owner) | Module | [0..1] |
+| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | 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 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] |
+
+### Dataset - Module - Transportation Systems
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | moduleName | The name of the module WIP | Transportation Systems | | | [0..1] |
+| 2 | transportMode | 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 | meansOfTransport | 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 | transportInfrastructure | 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 | dataGenerationMethod | 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 | surveyPopulation | 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 | elementaryUnit | 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] |
+| 8 | spatialUnit | 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] |
+| 9 | 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] |
+
+### Dataset - Module - Advanced Provenience
+|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
|
+|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
+| 1 | moduleName | The name of the module WIP | Advanced Provenience | | | [0..1] |
+| 2 | policy | 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 | objectLifeCycleType | 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 | objectTombstoneInformation | 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 | provenanceGraph | 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 | wasGeneratedBy | 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] |
+
+
### MetaMetadata Keys
|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Card.
|
|--------------------------------|----------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------|------------------------------------|
diff --git a/oemetadata/v2/v21/metadata_key_details.md b/oemetadata/v2/v21/metadata_key_details.md
index bb2ef8a9..ab2e365b 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,138 @@ 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
+
+### Dataset - Module - Energy Systems
+| | |
+|----------------|------------------------------------------------------------------|
+| Key | **moduleEnergySystems** |
+| Description | An Object that describes the main concepts of an energy system. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - supplyTechnologies
+| | |
+|----------------|----------------------------------------------------------------------------------------------------------------------------|
+| Key | **supplyTechnologies** |
+| Description | A supply technology describes how specific technical components and processes are combined to generate or provide energy. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - storageTechnologies
+| | |
+|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **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. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - supplyGrid
+| | |
+|----------------|---------------------------------------------------------------------------------------------------------------------------------|
+| Key | **supplyGrid** |
+| Description | A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - finalEnergyCarrier
+| | |
+|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **finalEnergyCarrier** |
+| 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 | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - demandSectors
+| | |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------|
+| Key | **demandSectors** |
+| Description | An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics. |
+| Example | |
+| Ontology Class | |
+| Card. | [0..1] |
+
+### Dataset - Module - Energy Systems - 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] |
+
+
+### 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 | [dct:identifier](http://purl.org/dc/terms/identifier) |
+| 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 | [dct:url](http://purl.org/dc/terms/url) |
+| 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 | [dct:name](http://purl.org/dc/terms/name) |
+| 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 | [sc:owner](https://schema.org/owner) |
+| Card. | [0..1] |
+
+### Dataset - Module - Measurement Data - manufacturerName
+| | |
+|----------------|-----------------------------------------------------|
+| Key | **manufacturerName** |
+| Description | Full name of the manufacturer. |
+| Example | Merck KGaA |
+| Ontology Class | [sc:manufacturer](https://schema.org/manufacturer) |
+| 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 | Example instrument of PIDINST schema. |
+| Ontology Class | [dct:description](http://purl.org/dc/terms/description) |
+| Card. | [0..1] |
+
### MetaMetadata Keys
| | |
@@ -1349,7 +1480,7 @@ If a value is not yet available, use: `ToDo`.
| Description | An object that describes the metadata themselves, their format, version and license. |
| Example | |
| Ontology Class | |
-| Card. | [1] |
+| Card. | [0..1] |
### MetaMetadata Keys - metadataVersion
| | |
diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json
index 41f45a2f..0e2edf9c 100644
--- a/oemetadata/v2/v21/schema.json
+++ b/oemetadata/v2/v21/schema.json
@@ -453,6 +453,299 @@
"title": "Contributor"
}
},
+ "moduleEnergySystems": {
+ "description": "An Object that describes the main concepts of an energy system.",
+ "type": "object",
+ "properties": {
+ "supplyTechnologies": {
+ "description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy transformation"
+ ],
+ "badge": "Module",
+ "title": "Supply Technologies Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00020003"
+ ],
+ "badge": "Module",
+ "title": "Supply Technologies Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Supply Technologies 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy storage technology"
+ ],
+ "badge": "Module",
+ "title": "Storage Technologies Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00020366"
+ ],
+ "badge": "Module",
+ "title": "Storage Technologies Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Storage Technologies 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "supply grid"
+ ],
+ "badge": "Module",
+ "title": "Supply Grid Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00000200"
+ ],
+ "badge": "Module",
+ "title": "Supply Grid Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Supply Grid 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "final energy carrier"
+ ],
+ "badge": "Module",
+ "title": "Final Energy Carrier Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00140080"
+ ],
+ "badge": "Module",
+ "title": "Final Energy Carrier Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Final Energy Carrier 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.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A class label of the ontology term.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "energy demand sector"
+ ],
+ "badge": "Module",
+ "title": "Demand Sectors Subject Name"
+ },
+ "@id": {
+ "description": "A unique identifier (URI/IRI) of the ontology class.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "https://openenergyplatform.org/ontology/oeo/OEO_00000128"
+ ],
+ "badge": "Module",
+ "title": "Demand Sectors Subject Identifier",
+ "format": "uri"
+ }
+ },
+ "badge": "Module",
+ "title": "Demand Sectors 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.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "Example module for an energy system dataset"
+ ],
+ "badge": "Module",
+ "title": "Energy Systems Module Description"
+ }
+ },
+ "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",
+ "examples": [
+ "Example instrument of PIDINST schema."
+ ],
+ "badge": "Module",
+ "title": "Module Description"
+ }
+ },
+ "badge": "Module",
+ "title": "Instrument"
+ },
+ "badge": "Module",
+ "title": "Measurement Data Module"
+ },
"datasetLicenses": {
"description": "An array of objects of licenses under which the described data is provided.",
"type": "array",
@@ -534,10 +827,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.",
@@ -613,7 +906,7 @@
"null"
],
"examples": [
- "example.csv"
+ "oemetadata_table_example"
],
"badge": "Iron",
"title": "Name"
@@ -630,24 +923,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": [
@@ -673,6 +948,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 99677cdd..6a12e2ef 100644
--- a/oemetadata/v2/v21/template.json
+++ b/oemetadata/v2/v21/template.json
@@ -48,6 +48,49 @@
"comment": ""
}
],
+ "moduleEnergySystems": {
+ "supplyTechnologies": [
+ {
+ "name": "",
+ "@id": ""
+ }
+ ],
+ "storageTechnologies": [
+ {
+ "name": "",
+ "@id": ""
+ }
+ ],
+ "supplyGrid": [
+ {
+ "name": "",
+ "@id": ""
+ }
+ ],
+ "finalEnergyCarrier": [
+ {
+ "name": "",
+ "@id": ""
+ }
+ ],
+ "demandSectors": [
+ {
+ "name": "",
+ "@id": ""
+ }
+ ],
+ "moduleDescription": ""
+ },
+ "moduleMeasurementData": [
+ {
+ "instrumentIdentifier": "",
+ "instrumentPath": "",
+ "instrumentName": "",
+ "instrumentOwner": "",
+ "manufacturerName": "",
+ "moduleDescription": ""
+ }
+ ],
"datasetLicenses": [
{
"name": "",
@@ -68,11 +111,11 @@
"path": "",
"name": "",
"title": "",
+ "description": "",
+ "publicationDate": "",
"topics": [
""
],
- "description": "",
- "publicationDate": "",
"subject": [
{
"name": "",
diff --git a/test/oemetadata/v2/v21/test_example.py b/test/oemetadata/v2/v21/test_example.py
index 40283264..111f9104 100644
--- a/test/oemetadata/v2/v21/test_example.py
+++ b/test/oemetadata/v2/v21/test_example.py
@@ -11,6 +11,13 @@ def test_oemetadata_example_should_load():
print("Cannot open OEMetadata Example (v2.1)!")
+def test_oemetadata_example_modules_should_load():
+ try:
+ pass
+ except Warning:
+ print("Cannot open OEMetadata Example Modules (v2.1)!")
+
+
def test_oemetadata_schema_should_validate_oemetadata_example():
from jsonschema import ValidationError, validate
@@ -24,6 +31,19 @@ def test_oemetadata_schema_should_validate_oemetadata_example():
print("Cannot validate OEMetadata Example with Schema (v2.1)!", e)
+def test_oemetadata_schema_should_validate_oemetadata_example_modules():
+ from jsonschema import ValidationError, validate
+
+ from oemetadata.v2.v21.example_modules import OEMETADATA_V21_EXAMPLE_MODULES
+ from oemetadata.v2.v21.schema import OEMETADATA_V21_SCHEMA
+
+ try:
+ validate(OEMETADATA_V21_EXAMPLE_MODULES, OEMETADATA_V21_SCHEMA)
+ print("OEMetadata Example Modules is valid OEMetadata Schema (v2.1).")
+ except ValidationError as e:
+ print("Cannot validate OEMetadata Example Modules with Schema (v2.1)!", e)
+
+
def test_oemetadata_example_is_datapackage():
from frictionless import Package
@@ -32,3 +52,13 @@ def test_oemetadata_example_is_datapackage():
descriptor = OEMETADATA_V21_EXAMPLE.to_descriptor()
errors = list(Package.metadata_validate(descriptor))
assert not errors, [str(e) for e in errors]
+
+
+def test_oemetadata_example_modules_is_datapackage():
+ from frictionless import Package
+
+ from oemetadata.v2.v21.example_modules import OEMETADATA_V21_EXAMPLE_MODULES
+
+ descriptor = OEMETADATA_V21_EXAMPLE_MODULES.to_descriptor()
+ errors = list(Package.metadata_validate(descriptor))
+ assert not errors, [str(e) for e in errors]