Skip to content

Add new module Measurement Data #299 #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Ludee wants to merge 10 commits into
base: develop
Choose a base branch
from
Draft

Add new module Measurement Data #299 #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4c9dc73
Add new module and update scipts to gernerate example #298
Ludee May 8, 2026
0bda751
Update function and docstings #298
Ludee May 8, 2026
275c5c2
Update changelog #298
Ludee May 8, 2026
9c277f1
Update key details #298
Ludee May 8, 2026
8440e1b
Update key details #298
Ludee May 8, 2026
881383f
Merge branch 'develop' into feature-298-module-energy-system
Ludee May 8, 2026
f2cd7b3
Reformat docs #298
Ludee May 8, 2026
c3d97e3
Add measurement module and fix naming nuke commit #299
Ludee May 8, 2026
34fbb83
update scripts #299
Ludee May 10, 2026
8dc7a83
Update documentation #299
Ludee May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
127 changes: 65 additions & 62 deletions docs/oemetadata/metadata_key_description.md
View file
Open in desktop

Large diffs are not rendered by default.

67 changes: 67 additions & 0 deletions docs/oemetadata/metadata_key_details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
| | |
|----------------|--------------------------------------------------------------------------------------|
Expand Down
6 changes: 6 additions & 0 deletions oemetadata/v2/v21/build_source/schema_structure.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@
"provenance": {
"$ref": "provenance.json#"
},
"moduleEnergySystems": {
"$ref": "module_energy_systems.json#"
},
"moduleMeasurementData": {
"$ref": "module_measurement_data.json#"
},
"datasetLicenses": {
"$ref": "licenses_dataset.json#"
},
Expand Down
38 changes: 19 additions & 19 deletions oemetadata/v2/v21/build_source/schemas/general.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"null"
],
"examples": [
"example.csv"
"oemetadata_table_example"
],
"badge": "Iron",
"title": "Name"
Expand All @@ -53,24 +53,6 @@
"badge": "Silver",
"title": "Title"
},
"topics": {
"description": "An array of predefined topics that correspond to the database schemas of the OEP.",
"type": "array",
"items": {
"description": "The topics are used to group the data in the database.",
"type": [
"string",
"null"
],
"examples": [
"model_draft"
],
"badge": "Bronze",
"title": "Topic"
},
"badge": "Bronze",
"title": "Topics"
},
"description": {
"description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.",
"type": [
Expand All @@ -95,6 +77,24 @@
"badge": "Bronze",
"title": "Publication Date",
"format": "date"
},
"topics": {
"description": "An array of predefined topics that correspond to the database schemas of the OEP.",
"type": "array",
"items": {
"description": "The topics are used to group the data in the database.",
"type": [
"string",
"null"
],
"examples": [
"model_draft"
],
"badge": "Bronze",
"title": "Topic"
},
"badge": "Bronze",
"title": "Topics"
}
},
"required": [
Expand Down
4 changes: 2 additions & 2 deletions oemetadata/v2/v21/build_source/schemas/licenses_dataset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@
}
},
"badge": "Bronze",
"title": "License"
"title": "Dataset License"
},
"badge": "Bronze",
"title": "Licenses"
"title": "Dataset Licenses"
}
}
}
217 changes: 217 additions & 0 deletions oemetadata/v2/v21/build_source/schemas/module_energy_systems.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_energy_systems.json",
"type": "object",
"properties": {
"moduleEnergySystems": {
"description": "An Object that describes the main concepts of an energy system.",
"type": "object",
"properties": {
"supplyTechnologies": {
"description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "A class label of the ontology term.",
"type": [
"string",
"null"
],
"examples": [
"energy transformation"
],
"badge": "Module",
"title": "Supply Technologies Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00020003"
],
"badge": "Module",
"title": "Supply Technologies Subject Identifier",
"format": "uri"
}
},
"badge": "Module",
"title": "Supply Technologies Subject"
},
"badge": "Module",
"title": "Supply Technologies"
},
"storageTechnologies": {
"description": "An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "A class label of the ontology term.",
"type": [
"string",
"null"
],
"examples": [
"energy storage technology"
],
"badge": "Module",
"title": "Storage Technologies Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00020366"
],
"badge": "Module",
"title": "Storage Technologies Subject Identifier",
"format": "uri"
}
},
"badge": "Module",
"title": "Storage Technologies Subject"
},
"badge": "Module",
"title": "Storage Technologies"
},
"supplyGrid": {
"description": "A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "A class label of the ontology term.",
"type": [
"string",
"null"
],
"examples": [
"supply grid"
],
"badge": "Module",
"title": "Supply Grid Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00000200"
],
"badge": "Module",
"title": "Supply Grid Subject Identifier",
"format": "uri"
}
},
"badge": "Module",
"title": "Supply Grid Subject"
},
"badge": "Module",
"title": "Supply Grid"
},
"finalEnergyCarrier": {
"description": "A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "A class label of the ontology term.",
"type": [
"string",
"null"
],
"examples": [
"final energy carrier"
],
"badge": "Module",
"title": "Final Energy Carrier Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00140080"
],
"badge": "Module",
"title": "Final Energy Carrier Subject Identifier",
"format": "uri"
}
},
"badge": "Module",
"title": "Final Energy Carrier Subject"
},
"badge": "Module",
"title": "Final Energy Carrier"
},
"demandSectors": {
"description": "An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "A class label of the ontology term.",
"type": [
"string",
"null"
],
"examples": [
"energy demand sector"
],
"badge": "Module",
"title": "Demand Sectors Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00000128"
],
"badge": "Module",
"title": "Demand Sectors Subject Identifier",
"format": "uri"
}
},
"badge": "Module",
"title": "Demand Sectors Subject"
},
"badge": "Module",
"title": "Demand Sectors"
},
"moduleDescription": {
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
"type": [
"string",
"null"
],
"examples": [
"Example module for an energy system dataset"
],
"badge": "Module",
"title": "Energy Systems Module Description"
}
},
"badge": "Module",
"title": "Energy Systems Module"
}
}
}
Loading
Loading