Skip to content

Commit

Permalink
Add first version of a common scenario data format #79
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludee committed Apr 14, 2020
1 parent c8710e2 commit 75c497e
Show file tree
Hide file tree
Showing 4 changed files with 207 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
id;scenario;region;year;schema;field;category;parameter;value;unit;tags;aggregation;source;comment
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
id;scenario;region;year;schema;field;category;parameter;timeindex;value;comment
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
{"name": "OEP-Szenariendatenformat",
"title": "OpenEnergyPlatform data format for scenario data",
"id": "",
"description": "",
"language": ["en-GB", "de-DE"],
"keywords": [""],
"publicationDate": "2020-04-14",
"context":
{"homepage": "",
"documentation": "",
"sourceCode": "",
"contact": "",
"grantNo": "",
"fundingAgency": "",
"fundingAgencyLogo": "",
"publisherLogo": ""},
"spatial":
{"location": "",
"extent": "",
"resolution": ""},
"temporal":
{"referenceDate": "",
"timeseries":
{"start": "",
"end": "",
"resolution": "",
"alignment": "",
"aggregationType": ""} },
"sources": [
{"title": "",
"description": "",
"path": "",
"licenses": [
{"name": "",
"title": "",
"path": "",
"instruction": "",
"attribution": ""} ] },
{"title": "",
"description": "",
"path": "",
"licenses": [
{"name": "",
"title": "",
"path": "",
"instruction": "",
"attribution": ""} ] } ],
"licenses": [
{"name": "",
"title": "",
"path": "",
"instruction": "",
"attribution": ""} ],
"contributors": [
{"title": "Ludee", "email": null, "date": "2020-04-14", "object": "metadata", "comment": "Create metadata template"},
{"title": "", "email": "", "date": "", "object": "", "comment": ""} ],
"resources": [
{"profile": "tabular-data-resource",
"name": "oep-scenario-data_scalar",
"path": "oep-scenario-data_scalar.csv",
"format": "csv",
"encoding" : "UTF-8",
"schema": {
"fields": [
{"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
{"name": "scenario", "description": "Scenario name", "type": "text", "unit": null},
{"name": "region", "description": "Country or region", "type": "text", "unit": null},
{"name": "year", "description": "Year", "type": "integer", "unit": null},
{"name": "schema", "description": "1. classification", "type": "text", "unit": null},
{"name": "field", "description": "2. classification", "type": "text", "unit": null},
{"name": "category", "description": "3. classification", "type": "text", "unit": null},
{"name": "parameter", "description": "Parameter name", "type": "text", "unit": null},
{"name": "value", "description": "Parameter value", "type": "decimal", "unit": "unit"},
{"name": "unit", "description": "Parameter unit", "type": "text", "unit": null},
{"name": "tags", "description": "Free classification with key-value pairs", "type": "hstore", "unit": null},
{"name": "aggregation", "description": "Aggregation type (sum, mean, median)", "type": "text", "unit": null},
{"name": "source", "description": "Source", "type": "text", "unit": null},
{"name": "comment", "description": "Comment", "type": "text", "unit": null} ],
"primaryKey": ["id"],
"foreignKeys": [{
"fields": [""],
"reference": {
"resource": "",
"fields": [""] } } ] },
"dialect":
{"delimiter": ";",
"decimalSeparator": "."} },

{"profile": "tabular-data-resource",
"name": "oep-scenario-data_timeserie",
"path": "oep-scenario-data_timeserie.csv",
"format": "csv",
"encoding" : "UTF-8",
"schema": {
"fields": [
{"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
{"name": "scenario", "description": "Scenario name", "type": "text", "unit": null},
{"name": "region", "description": "Country or region", "type": "text", "unit": null},
{"name": "year", "description": "Year", "type": "integer", "unit": null},
{"name": "schema", "description": "1. classification", "type": "text", "unit": null},
{"name": "field", "description": "2. classification", "type": "text", "unit": null},
{"name": "category", "description": "3. classification", "type": "text", "unit": null},
{"name": "timeindex", "description": "Time step", "type": "timestamp/integer", "unit": null},
{"name": "parameter", "description": "Parameter name", "type": "text", "unit": null},
{"name": "value", "description": "Parameter value", "type": "decimal", "unit": "kW"},
{"name": "comment", "description": "Comment", "type": "text", "unit": null} ],
"primaryKey": ["id"],
"foreignKeys": [{
"fields": [""],
"reference": {
"resource": "",
"fields": [""] } } ] },
"dialect":
{"delimiter": ";",
"decimalSeparator": "."} } ],

"review": {
"path": "",
"badge": ""},
"metaMetadata":
{"metadataVersion": "OEP-1.4.0",
"metadataLicense":
{"name": "CC0-1.0",
"title": "Creative Commons Zero v1.0 Universal",
"path": "https://creativecommons.org/publicdomain/zero/1.0/"} },
"_comment":
{"metadata": "Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/organisation/wiki/metadata)",
"dates": "Dates and time must follow the ISO8601 including time zone (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh)",
"units": "Use a space between numbers and units (100 m)",
"languages": "Languages must follow the IETF (BCP47) format (en-GB, en-US, de-DE)",
"licenses": "License name must follow the SPDX License List (https://spdx.org/licenses/)",
"review": "Following the OEP Data Review (https://github.com/OpenEnergyPlatform/data-preprocessing/wiki)",
"null": "If not applicable use (null)"} }
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:java="http://www.yworks.com/xml/yfiles-common/1.0/java" xmlns:sys="http://www.yworks.com/xml/yfiles-common/markup/primitives/2.0" xmlns:x="http://www.yworks.com/xml/yfiles-common/markup/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
<!--Created by yEd 3.18.2-->
<key attr.name="Beschreibung" attr.type="string" for="graph" id="d0"/>
<key for="port" id="d1" yfiles.type="portgraphics"/>
<key for="port" id="d2" yfiles.type="portgeometry"/>
<key for="port" id="d3" yfiles.type="portuserdata"/>
<key attr.name="url" attr.type="string" for="node" id="d4"/>
<key attr.name="description" attr.type="string" for="node" id="d5"/>
<key for="node" id="d6" yfiles.type="nodegraphics"/>
<key for="graphml" id="d7" yfiles.type="resources"/>
<key attr.name="url" attr.type="string" for="edge" id="d8"/>
<key attr.name="description" attr.type="string" for="edge" id="d9"/>
<key for="edge" id="d10" yfiles.type="edgegraphics"/>
<graph edgedefault="directed" id="G">
<data key="d0" xml:space="preserve"/>
<node id="n0">
<data key="d6">
<y:GenericNode configuration="com.yworks.entityRelationship.big_entity">
<y:Geometry height="221.21263157894742" width="145.0" x="66.0" y="172.99999999999997"/>
<y:Fill color="#339966" color2="#FFFFFF" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" backgroundColor="#339966" configuration="com.yworks.entityRelationship.label.name" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasLineColor="false" height="18.701171875" horizontalTextPosition="center" iconTextGap="4" modelName="internal" modelPosition="t" textColor="#000000" verticalTextPosition="bottom" visible="true" width="52.6796875" x="46.16015625" xml:space="preserve" y="4.0">timeserie</y:NodeLabel>
<y:NodeLabel alignment="left" autoSizePolicy="content" configuration="com.yworks.entityRelationship.label.attributes" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="165.712890625" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="top" visible="true" width="122.03125" x="2.0" xml:space="preserve" y="30.701171875">id (int)
scenario (text)
region (text)
year (int)
schema (text)
field (text)
category (text)
timeindex (timestamp)
parameter (decimal)
value (text)
comment (text)<y:LabelModel><y:ErdAttributesNodeLabelModel/></y:LabelModel><y:ModelParameter><y:ErdAttributesNodeLabelModelParameter/></y:ModelParameter></y:NodeLabel>
<y:StyleProperties>
<y:Property class="java.lang.Boolean" name="y.view.ShadowNodePainter.SHADOW_PAINTING" value="true"/>
</y:StyleProperties>
</y:GenericNode>
</data>
</node>
<node id="n1">
<data key="d6">
<y:GenericNode configuration="com.yworks.entityRelationship.big_entity">
<y:Geometry height="262.0" width="135.0" x="275.1224140350877" y="173.0"/>
<y:Fill color="#FFFFFF" color2="#339966" transparent="false"/>
<y:BorderStyle color="#000000" type="line" width="1.0"/>
<y:NodeLabel alignment="center" autoSizePolicy="content" backgroundColor="#339966" configuration="com.yworks.entityRelationship.label.name" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasLineColor="false" height="18.701171875" horizontalTextPosition="center" iconTextGap="4" modelName="internal" modelPosition="t" textColor="#000000" verticalTextPosition="bottom" visible="true" width="36.009765625" x="49.4951171875" xml:space="preserve" y="4.0">scalar</y:NodeLabel>
<y:NodeLabel alignment="left" autoSizePolicy="content" configuration="com.yworks.entityRelationship.label.attributes" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="209.81640625" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="top" visible="true" width="98.0546875" x="2.0" xml:space="preserve" y="30.701171875">id (int)
scenario (text)
region (text)
year (int)
schema (text)
field (text)
category (text)
parameter (text)
value (decimal)
unit (text)
tags (hstore)
aggregation (text)
source (text)
comment (text)<y:LabelModel><y:ErdAttributesNodeLabelModel/></y:LabelModel><y:ModelParameter><y:ErdAttributesNodeLabelModelParameter/></y:ModelParameter></y:NodeLabel>
<y:StyleProperties>
<y:Property class="java.lang.Boolean" name="y.view.ShadowNodePainter.SHADOW_PAINTING" value="true"/>
</y:StyleProperties>
</y:GenericNode>
</data>
</node>
</graph>
<data key="d7">
<y:Resources/>
</data>
</graphml>

0 comments on commit 75c497e

Please sign in to comment.