Skip to content

Add new module data transformation software #300 #314

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

Open
Ludee wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

Add new module data transformation software #300 #314

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
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
4706bed
Update Module Software #300
Ludee Jun 4, 2026
432c392
Update software name #300
Ludee Jun 4, 2026
75d9d8a
Update software path #300
Ludee Jun 4, 2026
d9070a1
Update software version #300
Ludee Jun 4, 2026
d7ffd19
Update software version and type #300
Ludee Jun 4, 2026
0212f78
Update software programming language #300
Ludee Jun 4, 2026
765b88e
Update schema and rerun examples #300
Ludee Jun 4, 2026
1b1f6fe
Update Changelog #300
Ludee Jun 15, 2026
2a23b51
Fix module description from review #300
Ludee Jun 29, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- 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)
- Add a module `Data Transformation Software` for dataset [(#314)](https://github.com/OpenEnergyPlatform/oemetadata/pull/314)

### Changed
- Update TLDR URL in example sourceLicenses [(#275)](https://github.com/OpenEnergyPlatform/oemetadata/pull/275)
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 @@ -22,6 +22,12 @@
"moduleEnergySystems": {
"$ref": "module_energy_systems.json#"
},
"moduleMeasurementData": {
"$ref": "module_measurement_data.json#"
},
"moduleDataTransformationSoftware": {
"$ref": "module_software.json#"
},
"datasetLicenses": {
"$ref": "licenses_dataset.json#"
},
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"
}
}
}
90 changes: 45 additions & 45 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
Expand Up @@ -8,7 +8,7 @@
"type": "object",
"properties": {
"supplyTechnologies": {
"description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy",
"description": "A supply technology describes how specific technical components and processes are combined to generate or provide energy.",
"type": "array",
"items": {
"type": "object",
Expand All @@ -22,8 +22,8 @@
"examples": [
"energy transformation"
],
"badge": "Platinum",
"title": "Subject Name"
"badge": "Module",
"title": "Supply Technologies Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
Expand All @@ -34,16 +34,16 @@
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00020003"
],
"badge": "Platinum",
"title": "Subject Identifier",
"badge": "Module",
"title": "Supply Technologies Subject Identifier",
"format": "uri"
}
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Supply Technologies Subject"
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Supply Technologies"
},
"storageTechnologies": {
"description": "An energy storage technology describes how energy storage components and energy carriers are combined to charge, store, and discharge energy for temporary use.",
Expand All @@ -60,8 +60,8 @@
"examples": [
"energy storage technology"
],
"badge": "Platinum",
"title": "Subject Name"
"badge": "Module",
"title": "Storage Technologies Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
Expand All @@ -72,16 +72,16 @@
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00020366"
],
"badge": "Platinum",
"title": "Subject Identifier",
"badge": "Module",
"title": "Storage Technologies Subject Identifier",
"format": "uri"
}
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Storage Technologies Subject"
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Storage Technologies"
},
"supplyGrid": {
"description": "A supply grid is a system of interconnected technical components that together enable the distribution and delivery of energy.",
Expand All @@ -98,8 +98,8 @@
"examples": [
"supply grid"
],
"badge": "Platinum",
"title": "Subject Name"
"badge": "Module",
"title": "Supply Grid Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
Expand All @@ -110,16 +110,16 @@
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00000200"
],
"badge": "Platinum",
"title": "Subject Identifier",
"badge": "Module",
"title": "Supply Grid Subject Identifier",
"format": "uri"
}
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Supply Grid Subject"
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Supply Grid"
},
"finalEnergyCarrier": {
"description": "A final energy carrier is an energy carrier that is delivered to and directly used by end users without further transformation.",
Expand All @@ -136,8 +136,8 @@
"examples": [
"final energy carrier"
],
"badge": "Platinum",
"title": "Subject Name"
"badge": "Module",
"title": "Final Energy Carrier Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
Expand All @@ -148,16 +148,16 @@
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00140080"
],
"badge": "Platinum",
"title": "Subject Identifier",
"badge": "Module",
"title": "Final Energy Carrier Subject Identifier",
"format": "uri"
}
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Final Energy Carrier Subject"
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Final Energy Carrier"
},
"demandSectors": {
"description": "An energy demand sector is a sector of the energy system that groups together energy consumers with similar usage characteristics.",
Expand All @@ -174,8 +174,8 @@
"examples": [
"energy demand sector"
],
"badge": "Platinum",
"title": "Subject Name"
"badge": "Module",
"title": "Demand Sectors Subject Name"
},
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
Expand All @@ -186,16 +186,16 @@
"examples": [
"https://openenergyplatform.org/ontology/oeo/OEO_00000128"
],
"badge": "Platinum",
"title": "Subject Identifier",
"badge": "Module",
"title": "Demand Sectors Subject Identifier",
"format": "uri"
}
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Demand Sectors Subject"
},
"badge": "Platinum",
"title": "Subject"
"badge": "Module",
"title": "Demand Sectors"
},
"moduleDescription": {
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
Expand All @@ -206,12 +206,12 @@
"examples": [
"Example module for an energy system dataset"
],
"badge": "Gold",
"title": "Context Title"
"badge": "Module",
"title": "Energy Systems Module Description"
}
},
"badge": "Gold",
"title": "Context"
"badge": "Module",
"title": "Energy Systems Module"
}
}
}
93 changes: 93 additions & 0 deletions oemetadata/v2/v21/build_source/schemas/module_measurement_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_measurement_data.json",
"type": "object",
"properties": {
"moduleMeasurementData": {
"description": "An Object that describes the instruments used in the measurement.",
"type": "array",
"items": {
"type": "object",
"properties": {
"instrumentIdentifier": {
"description": "Unique string that identifies the instrument instance.",
"type": [
"string",
"null"
],
"examples": [
"http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922"
],
"badge": "Module",
"title": "Instrument Identifier"
},
"instrumentPath": {
"description": "A landing page that the identifier resolves to.",
"type": [
"string",
"null"
],
"examples": [
"https://sms.atmohub.kit.edu/devices/961"
],
"badge": "Module",
"title": "Instrument Path",
"format": "uri"
},
"instrumentName": {
"description": "Name by which the instrument instance is known.",
"type": [
"string",
"null"
],
"examples": [
"MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004"
],
"badge": "Module",
"title": "Instrument Name"
},
"instrumentOwner": {
"description": "Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument.",
"type": [
"string",
"null"
],
"examples": [
"Karlsruhe Institute of Technology (KIT)"
],
"badge": "Module",
"title": "Instrument Owner"
},
"manufacturerName": {
"description": "Full name of the manufacturer.",
"type": [
"string",
"null"
],
"examples": [
"Merck KGaA"
],
"badge": "Module",
"title": "Manufacturer Name"
},
"moduleDescription": {
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
"type": [
"string",
"null"
],
"examples": [
"Example instrument of PIDINST schema."
],
"badge": "Module",
"title": "Module Description"
}
},
"badge": "Module",
"title": "Instrument"
},
"badge": "Module",
"title": "Measurement Data Module"
}
}
}
Loading
Loading