Skip to content

Commit c239f0d

Browse files
author
Philipp Schmurr
committed
updated measurement module with semantic links and a new property
1 parent 8dc7a83 commit c239f0d

7 files changed

Lines changed: 74 additions & 25 deletions

File tree

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@
1111
"properties": {
1212
"instrumentIdentifier": {
1313
"description": "Unique string that identifies the instrument instance.",
14-
"type": [
15-
"string",
16-
"null"
17-
],
14+
"type": "string",
1815
"examples": [
1916
"http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922"
2017
],
@@ -70,12 +67,21 @@
7067
"badge": "Module",
7168
"title": "Manufacturer Name"
7269
},
73-
"moduleDescription": {
74-
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
70+
"instrumentConfiguration": {
71+
"description": "URL to a configuration of the instrument used for the experiment",
7572
"type": [
7673
"string",
7774
"null"
7875
],
76+
"examples": [
77+
"https://example.com/my/experiment/instrument/config.yaml"
78+
],
79+
"badge": "Module",
80+
"title": "Instrument Configuration"
81+
},
82+
"moduleDescription": {
83+
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
84+
"type": "string",
7985
"examples": [
8086
"Example instrument of PIDINST schema."
8187
],
@@ -84,7 +90,11 @@
8490
}
8591
},
8692
"badge": "Module",
87-
"title": "Instrument"
93+
"title": "Instrument",
94+
"required": [
95+
"instrumentIdentifier",
96+
"moduleDescription"
97+
]
8898
},
8999
"badge": "Module",
90100
"title": "Measurement Data Module"

‎oemetadata/v2/v21/context.json‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"dcat": "https://www.w3.org/ns/dcat#",
99
"dct": "https://purl.org/dc/terms/",
1010
"foaf": "http://xmlns.com/foaf/0.1/",
11+
"m4i": "https://w3id.org/nfdi4ing/metadata4ing#",
1112
"ncit": "http://purl.obolibrary.org/obo/ncit.owl",
1213
"oeo": "https://openenergyplatform.org/ontology/oeo/",
1314
"owl": "http://www.w3.org/2002/07/owl#",
@@ -327,6 +328,31 @@
327328
"@id": "owl:versionInfo",
328329
"@type": "xsd:string"
329330
},
330-
"metadataLicense": "@nest"
331+
"metadataLicense": "@nest",
332+
"moduleMeasurementData": {"@container": "@set", "@id": "dcat:hasPart"},
333+
"instrumentIdentifier": {
334+
"@id": "dct:identifier",
335+
"@type": "@id"
336+
},
337+
"instrumentPath": {
338+
"@id": "dct:url",
339+
"@type": "xsd:string"
340+
},
341+
"instrumentName": {
342+
"@id": "dct:name",
343+
"@type": "xsd:string"
344+
},
345+
"instrumentOwner": {
346+
"@id": "sc:owner",
347+
"@type": "xsd:string"
348+
},
349+
"instrumentConfiguration": {
350+
"@id": "m4i:hasParameterSet",
351+
"@type": "xsd:AnyUrl"
352+
},
353+
"manufacturerName": {
354+
"@id": "sc:manufacturer",
355+
"@type": "xsd:string"
356+
}
331357
}
332358
}

‎oemetadata/v2/v21/example.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@
348348
},
349349
{
350350
"name": "comment",
351-
"description": "",
351+
"description": "Comment",
352352
"type": "string",
353353
"nullable": true,
354354
"unit": null,

‎oemetadata/v2/v21/example_modules.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@
113113
"instrumentName": "MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004",
114114
"instrumentOwner": "Karlsruhe Institute of Technology (KIT)",
115115
"manufacturerName": "Merck KGaA",
116+
"instrumentConfiguration": "https://example.com/my/experiment/instrument/config.yaml",
116117
"moduleDescription": "Example instrument of PIDINST schema."
117118
}
118119
],
@@ -391,7 +392,7 @@
391392
},
392393
{
393394
"name": "comment",
394-
"description": "",
395+
"description": "Comment",
395396
"type": "string",
396397
"nullable": true,
397398
"unit": null,

‎oemetadata/v2/v21/metadata_key_description.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -244,14 +244,15 @@ If a value is not yet available, use: `ToDo`.
244244
| 6 | moduleDescription | A description of the module. It should be usable as summary information for the module that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Module | [0..1] |
245245

246246
### Dataset - Module - Measurement Data
247-
| <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> |
248-
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------|------------------------------------|------------------------------------|
249-
| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | | Module | [0..1] |
250-
| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | | Module | [0..1] |
251-
| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | | Module | [0..1] |
252-
| 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) | | Module | [0..1] |
253-
| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | | Module | [0..1] |
254-
| 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] |
247+
| <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">Semantic Property</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
248+
|--------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------|------------------------------------|------------------------------------|
249+
| 1 | instrumentIdentifier | Unique string that identifies the instrument instance. | http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922 | [dct:identifier](http://purl.org/dc/terms/identifier) | Module | 1 |
250+
| 2 | instrumentPath | A landing page that the identifier resolves to. | https://sms.atmohub.kit.edu/devices/961 | [dct:url](http://purl.org/dc/terms/url) | Module | [0..1] |
251+
| 3 | instrumentName | Name by which the instrument instance is known. | MFC_001000_02 - Merck KGaA - FC-2926V - DH9806004 | [dct:name](http://purl.org/dc/terms/name) | Module | [0..1] |
252+
| 4 | instrumentOwner | Institution(s) responsible for the management of the instrument. This may include the legal owner, the operator, or an institute providing access to the instrument. | Karlsruhe Institute of Technology (KIT) | [sc:owner](https://schema.org/owner) | Module | [0..1] |
253+
| 5 | manufacturerName | Full name of the manufacturer. | Merck KGaA | [sc:manufacturer](https://schema.org/manufacturer) | Module | [0..1] |
254+
| 6 | instrumentConfiguration | The configuration of the instrument that was used during measurement | https://example.com/a-file-that-describes-the-instrument-configuration | [m4i:hasParameterSet](https://w3id.org/nfdi4ing/metadata4ing#hasParameterSet) | Module | [0..1] |
255+
| 7 | 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 | 1 |
255256

256257
### Dataset - Module - Data Transformations & ERSMeta
257258
| <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: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -671,10 +671,7 @@
671671
"properties": {
672672
"instrumentIdentifier": {
673673
"description": "Unique string that identifies the instrument instance.",
674-
"type": [
675-
"string",
676-
"null"
677-
],
674+
"type": "string",
678675
"examples": [
679676
"http://hdl.handle.net/21.11157/a9250866-bbec-4542-86b3-a5f78c0c6922"
680677
],
@@ -730,12 +727,21 @@
730727
"badge": "Module",
731728
"title": "Manufacturer Name"
732729
},
733-
"moduleDescription": {
734-
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
730+
"instrumentConfiguration": {
731+
"description": "URL to a configuration of the instrument used for the experiment",
735732
"type": [
736733
"string",
737734
"null"
738735
],
736+
"examples": [
737+
"https://example.com/my/experiment/instrument/config.yaml"
738+
],
739+
"badge": "Module",
740+
"title": "Instrument Configuration"
741+
},
742+
"moduleDescription": {
743+
"description": "A description of the module. It should be usable as summary information for the module that is described by the metadata.",
744+
"type": "string",
739745
"examples": [
740746
"Example instrument of PIDINST schema."
741747
],
@@ -744,7 +750,11 @@
744750
}
745751
},
746752
"badge": "Module",
747-
"title": "Instrument"
753+
"title": "Instrument",
754+
"required": [
755+
"instrumentIdentifier",
756+
"moduleDescription"
757+
]
748758
},
749759
"badge": "Module",
750760
"title": "Measurement Data Module"

‎oemetadata/v2/v21/template.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
"instrumentName": "",
8989
"instrumentOwner": "",
9090
"manufacturerName": "",
91+
"instrumentConfiguration": "",
9192
"moduleDescription": ""
9293
}
9394
],

0 commit comments

Comments
 (0)