Skip to content

Commit ae2b6a0

Browse files
LudeeLudee
authored
Merge branch 'develop' into feature-299-module-measurements
2 parents 360aabe + fb7f756 commit ae2b6a0

8 files changed

Lines changed: 220 additions & 10 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2727
- Add temporal information to dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310)
2828
- Add a module `Energy Systems` for dataset [(#312)](https://github.com/OpenEnergyPlatform/oemetadata/pull/312)
2929
- Add a module `Measurement Data` for dataset [(#313)](https://github.com/OpenEnergyPlatform/oemetadata/pull/313)
30+
- Add a module `Data Transformation Software` for dataset [(#314)](https://github.com/OpenEnergyPlatform/oemetadata/pull/314)
3031

3132
### Changed
3233
- Update TLDR URL in example sourceLicenses [(#275)](https://github.com/OpenEnergyPlatform/oemetadata/pull/275)

‎oemetadata/v2/v21/build_source/schema_structure.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
"moduleMeasurementData": {
2626
"$ref": "module_measurement_data.json#"
2727
},
28+
"moduleDataTransformationSoftware": {
29+
"$ref": "module_software.json#"
30+
},
2831
"datasetLicenses": {
2932
"$ref": "licenses_dataset.json#"
3033
},

‎oemetadata/v2/v21/build_source/schemas/module_software.json‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/module_software.json",
4+
"type": "object",
5+
"properties": {
6+
"moduleDataTransformationSoftware": {
7+
"description": "An Object that describes a software used for data transformations.",
8+
"type": "array",
9+
"items": {
10+
"type": "object",
11+
"properties": {
12+
"softwareName": {
13+
"description": "Name of the software.",
14+
"type": [
15+
"string",
16+
"null"
17+
],
18+
"examples": [
19+
"open-mastr"
20+
],
21+
"badge": "Module",
22+
"title": "Software Name"
23+
},
24+
"softwarePath": {
25+
"description": "A link or identifier to download or access the software.",
26+
"type": [
27+
"string",
28+
"null"
29+
],
30+
"examples": [
31+
"https://github.com/OpenEnergyPlatform/open-MaStR"
32+
],
33+
"badge": "Module",
34+
"title": "Software Path"
35+
},
36+
"softwareVersion": {
37+
"description": "The version of the software instance.",
38+
"type": [
39+
"string",
40+
"null"
41+
],
42+
"examples": [
43+
"0.17.1"
44+
],
45+
"badge": "Module",
46+
"title": "Software Version"
47+
},
48+
"softwareType": {
49+
"description": "Type of software application.",
50+
"type": [
51+
"string",
52+
"null"
53+
],
54+
"examples": [
55+
"Library"
56+
],
57+
"badge": "Module",
58+
"title": "Software Type (ERSmeta)"
59+
},
60+
"programmingLanguage": {
61+
"description": "Type of software application.",
62+
"type": [
63+
"string",
64+
"null"
65+
],
66+
"examples": [
67+
"Python"
68+
],
69+
"badge": "Module",
70+
"title": "Software Type (ERSmeta)"
71+
},
72+
"moduleDescription": {
73+
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
74+
"type": [
75+
"string",
76+
"null"
77+
],
78+
"examples": [
79+
"Example data transformation software."
80+
],
81+
"badge": "Module",
82+
"title": "Module Description"
83+
}
84+
},
85+
"badge": "Module",
86+
"title": "Software"
87+
},
88+
"badge": "Module",
89+
"title": "Data Transformation Software Module"
90+
}
91+
}
92+
}

‎oemetadata/v2/v21/example.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@
7373
"comment": "Date of metadata creation"
7474
}
7575
],
76+
"moduleDataTransformationSoftware": [
77+
{
78+
"softwareName": "open-mastr",
79+
"softwarePath": "https://github.com/OpenEnergyPlatform/open-MaStR",
80+
"softwareVersion": "0.17.1",
81+
"softwareType": "Library",
82+
"programmingLanguage": "Python",
83+
"moduleDescription": "Example data transformation software."
84+
}
85+
],
7686
"datasetLicenses": [
7787
{
7888
"name": "ODbL-1.0",

‎oemetadata/v2/v21/example_modules.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,16 @@
116116
"moduleDescription": "Example instrument of PIDINST schema."
117117
}
118118
],
119+
"moduleDataTransformationSoftware": [
120+
{
121+
"softwareName": "open-mastr",
122+
"softwarePath": "https://github.com/OpenEnergyPlatform/open-MaStR",
123+
"softwareVersion": "0.17.1",
124+
"softwareType": "Library",
125+
"programmingLanguage": "Python",
126+
"moduleDescription": "Example data transformation software."
127+
}
128+
],
119129
"datasetLicenses": [
120130
{
121131
"name": "ODbL-1.0",

‎oemetadata/v2/v21/metadata_key_description.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -253,16 +253,15 @@ If a value is not yet available, use: `ToDo`.
253253
| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | Module | [0..1] |
254254
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example instrument of PIDINST schema. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
255255

256-
### Dataset - Module - Data Transformations & ERSMeta
257-
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
258-
|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
259-
| 1 | moduleName | The name of the module WIP | Data Transformations | | | [0..1] |
260-
| 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] |
261-
| 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] |
262-
| 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] |
263-
| 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] |
264-
| 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] |
265-
| 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] |
256+
### Dataset - Module - Data Transformation Software
257+
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
258+
|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|-------------------------------------------------------------------------------------|------------------------------------|------------------------------------|
259+
| 1 | softwareName | Name of the software. | open-mastr | [schema.org:name](https://schema.org/name) | Module | [0..1] |
260+
| 2 | softwarePath | A link or identifier to download or access the software. | https://github.com/OpenEnergyPlatform/open-MaStR | [schema.org:downloadURL](https://schema.org/downloadURL) | Module | [0..1] |
261+
| 3 | softwareVersion | The version of the software instance. | 0.17.1 | [schema.org:softwareVersion](https://schema.org/softwareVersion) | Module | [0..1] |
262+
| 4 | softwareType | Type of software application. | Library | [ersmeta:softwareType](https://nfdi4energy.github.io/ERSmeta/#ersmeta:softwareType) | Module | [0..1] |
263+
| 5 | programmingLanguage | The computer programming language in which the software is written. | Python | [schema.org:programmingLanguage](https://schema.org/programmingLanguage) | Module | [0..1] |
264+
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example data transformation software. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
266265

267266
### Dataset - Module - Transportation Systems
268267
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |

‎oemetadata/v2/v21/schema.json‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -746,6 +746,91 @@
746746
"badge": "Module",
747747
"title": "Measurement Data Module"
748748
},
749+
"moduleDataTransformationSoftware": {
750+
"description": "An Object that describes a software used for data transformations.",
751+
"type": "array",
752+
"items": {
753+
"type": "object",
754+
"properties": {
755+
"softwareName": {
756+
"description": "Name of the software.",
757+
"type": [
758+
"string",
759+
"null"
760+
],
761+
"examples": [
762+
"open-mastr"
763+
],
764+
"badge": "Module",
765+
"title": "Software Name"
766+
},
767+
"softwarePath": {
768+
"description": "A link or identifier to download or access the software.",
769+
"type": [
770+
"string",
771+
"null"
772+
],
773+
"examples": [
774+
"https://github.com/OpenEnergyPlatform/open-MaStR"
775+
],
776+
"badge": "Module",
777+
"title": "Software Path"
778+
},
779+
"softwareVersion": {
780+
"description": "The version of the software instance.",
781+
"type": [
782+
"string",
783+
"null"
784+
],
785+
"examples": [
786+
"0.17.1"
787+
],
788+
"badge": "Module",
789+
"title": "Software Version"
790+
},
791+
"softwareType": {
792+
"description": "Type of software application.",
793+
"type": [
794+
"string",
795+
"null"
796+
],
797+
"examples": [
798+
"Library"
799+
],
800+
"badge": "Module",
801+
"title": "Software Type (ERSmeta)"
802+
},
803+
"programmingLanguage": {
804+
"description": "Type of software application.",
805+
"type": [
806+
"string",
807+
"null"
808+
],
809+
"examples": [
810+
"Python"
811+
],
812+
"badge": "Module",
813+
"title": "Software Type (ERSmeta)"
814+
},
815+
"moduleDescription": {
816+
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
817+
"type": [
818+
"string",
819+
"null"
820+
],
821+
"examples": [
822+
"Example data transformation software."
823+
],
824+
"badge": "Module",
825+
"title": "Module Description"
826+
}
827+
},
828+
"badge": "Module",
829+
"title": "Software"
830+
},
831+
"badge": "Module",
832+
"title": "Data Transformation Software Module"
833+
},
749834
"datasetLicenses": {
750835
"description": "An array of objects of licenses under which the described data is provided.",
751836
"type": "array",

‎oemetadata/v2/v21/template.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@
9191
"moduleDescription": ""
9292
}
9393
],
94+
"moduleDataTransformationSoftware": [
95+
{
96+
"softwareName": "",
97+
"softwarePath": "",
98+
"softwareVersion": "",
99+
"softwareType": "",
100+
"programmingLanguage": "",
101+
"moduleDescription": ""
102+
}
103+
],
94104
"datasetLicenses": [
95105
{
96106
"name": "",

0 commit comments

Comments
 (0)