diff --git a/CHANGELOG.md b/CHANGELOG.md index 952dbd74..6eacb8ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,12 +25,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Tests for example and template to be valid frictionless datapackage [(#305)](https://github.com/OpenEnergyPlatform/oemetadata/pull/305) - Add spatial information to dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) - Add temporal information to dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) +- Add a module `Energy Systems` for dataset [(#312)](https://github.com/OpenEnergyPlatform/oemetadata/pull/312) ### Changed - Update TLDR URL in example sourceLicenses [(#275)](https://github.com/OpenEnergyPlatform/oemetadata/pull/275) - Scripts in build_source produce same json as provided in repo [(#284)](https://github.com/OpenEnergyPlatform/oemetadata/pull/284) - Update python env instructions to latest version [(#284)](https://github.com/OpenEnergyPlatform/oemetadata/pull/284) - Update datapackage logo link [(#311)](https://github.com/OpenEnergyPlatform/oemetadata/pull/311) +- Update `create_example.py` and add `example_modules.json` [(#312)](https://github.com/OpenEnergyPlatform/oemetadata/pull/312) ### Removed diff --git a/docs/oemetadata/metadata_key_description.md b/docs/oemetadata/metadata_key_description.md index 0df4d1b7..7ef26ebb 100644 --- a/docs/oemetadata/metadata_key_description.md +++ b/docs/oemetadata/metadata_key_description.md @@ -145,68 +145,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 +220,71 @@ 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 | 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] | + +### Dataset - Module - Measurement Data +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | moduleName | The name of the module WIP | Measurement Data | ? | Platinum | [0..1] | +| 2 | instrumentIdentifier | Unique string that identifies the instrument instance | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | ? | Platinum | [0..1] | +| 3 | instrumentPath | A landing page that the identifier resolves to | https://sms.atmohub.kit.edu/devices/961 | ? | Platinum | [0..1] | +| 5 | instrumentName | Name by which the instrument instance is known | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | ? | Platinum | [0..1] | +| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | ? | Platinum | [0..1] | +| 5 | manufacturerName | Full name of the manufacturer | Merck KGaA | ? | Platinum | [0..1] | +| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDInst. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] | + +### Dataset - Module - Data Transformations & ERSMeta +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | moduleName | The name of the module WIP | Data Transformations | | | [0..1] | +| 2 | softwareName | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 3 | softwarePath | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 4 | softwareVersion | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 5 | softwareType | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 6 | programmingLanguage | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | + +### 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..d4891cb5 100644 --- a/docs/oemetadata/metadata_key_details.md +++ b/docs/oemetadata/metadata_key_details.md @@ -1332,6 +1332,73 @@ If a value is not yet available, use: `ToDo`. | Ontology Class | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) | | Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [0..1] | + + ### MetaMetadata Keys | | | |----------------|--------------------------------------------------------------------------------------| diff --git a/oemetadata/v2/v21/build_source/schema_structure.json b/oemetadata/v2/v21/build_source/schema_structure.json index 1cf3e828..43f6c6d6 100644 --- a/oemetadata/v2/v21/build_source/schema_structure.json +++ b/oemetadata/v2/v21/build_source/schema_structure.json @@ -19,6 +19,9 @@ "provenance": { "$ref": "provenance.json#" }, + "moduleEnergySystems": { + "$ref": "module_energy_systems.json#" + }, "datasetLicenses": { "$ref": "licenses_dataset.json#" }, 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..b2d8a93a --- /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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Gold", + "title": "Context Title" + } + }, + "badge": "Gold", + "title": "Context" + } + } +} diff --git a/oemetadata/v2/v21/build_source/scripts/create_example.py b/oemetadata/v2/v21/build_source/scripts/create_example.py index 75aa9e04..07bd6fd2 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,6 @@ 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"]) 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/example_modules.json b/oemetadata/v2/v21/example_modules.json new file mode 100644 index 00000000..500d6c61 --- /dev/null +++ b/oemetadata/v2/v21/example_modules.json @@ -0,0 +1,435 @@ +{ + "@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.", + "topics": [ + "model_draft" + ], + "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" + }, + "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/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "badge": "Platinum" + }, + "resources": [ + { + "@id": "https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv", + "path": "example.csv", + "name": "example.csv", + "title": "OEMetadata Table Example", + "description": "Example metadata and table used to illustrate the OEMetadata structure and features.", + "publicationDate": "2024-10-15", + "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": "", + "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/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "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..150f2d44 100644 --- a/oemetadata/v2/v21/metadata_key_description.md +++ b/oemetadata/v2/v21/metadata_key_description.md @@ -32,24 +32,24 @@ 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) 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 | [*] | ### Dataset - Project Context Keys |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| @@ -150,68 +150,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 +225,71 @@ 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 | 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] | + +### Dataset - Module - Measurement Data +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | moduleName | The name of the module WIP | Measurement Data | ? | Platinum | [0..1] | +| 2 | instrumentIdentifier | Unique string that identifies the instrument instance | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | ? | Platinum | [0..1] | +| 3 | instrumentPath | A landing page that the identifier resolves to | https://sms.atmohub.kit.edu/devices/961 | ? | Platinum | [0..1] | +| 5 | instrumentName | Name by which the instrument instance is known | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | ? | Platinum | [0..1] | +| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | ? | Platinum | [0..1] | +| 5 | manufacturerName | Full name of the manufacturer | Merck KGaA | ? | Platinum | [0..1] | +| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDInst. | [dct:description](http://purl.org/dc/terms/description) | Platinum | [0..1] | + +### Dataset - Module - Data Transformations & ERSMeta +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------| +| 1 | moduleName | The name of the module WIP | Data Transformations | | | [0..1] | +| 2 | softwareName | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 3 | softwarePath | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 4 | softwareVersion | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 5 | softwareType | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 6 | programmingLanguage | XA base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 7 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | + +### 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..aeafdeb9 100644 --- a/oemetadata/v2/v21/metadata_key_details.md +++ b/oemetadata/v2/v21/metadata_key_details.md @@ -1342,6 +1342,73 @@ If a value is not yet available, use: `ToDo`. | Ontology Class | [oeo:quality control flag](https://openenergyplatform.org/ontology/oeo/OEO_00140098/) | | Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [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 | | +| Badge | [0..1] | + + ### MetaMetadata Keys | | | |----------------|--------------------------------------------------------------------------------------| diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index 41f45a2f..9c00855d 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -453,6 +453,216 @@ "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Platinum", + "title": "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": "Platinum", + "title": "Subject Identifier", + "format": "uri" + } + }, + "badge": "Platinum", + "title": "Subject" + }, + "badge": "Platinum", + "title": "Subject" + }, + "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": "Gold", + "title": "Context Title" + } + }, + "badge": "Gold", + "title": "Context" + }, "datasetLicenses": { "description": "An array of objects of licenses under which the described data is provided.", "type": "array", diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 99677cdd..3f067dec 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -48,6 +48,39 @@ "comment": "" } ], + "moduleEnergySystems": { + "supplyTechnologies": [ + { + "name": "", + "@id": "" + } + ], + "storageTechnologies": [ + { + "name": "", + "@id": "" + } + ], + "supplyGrid": [ + { + "name": "", + "@id": "" + } + ], + "finalEnergyCarrier": [ + { + "name": "", + "@id": "" + } + ], + "demandSectors": [ + { + "name": "", + "@id": "" + } + ], + "moduleDescription": "" + }, "datasetLicenses": [ { "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]