Merge pull request #40 from OpenEnergyPlatform/release/oedatamodel-v1…

….1.1 Release/oedatamodel v1.1.1
OpenEnergyPlatform · Dec 1, 2020 · 46a34b4 · 46a34b4
2 parents b69b108 + 8e7980f
commit 46a34b4
Show file tree

Hide file tree

Showing 29 changed files with 463 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,13 @@ Here is a template for new release sections
 ```
 ## Current
 
+### [1.1.1]
+- include feedback from open_MODEX project meeting in [PR#], this includes:
+    - changing scenarion.region type to json
+    - timeseries fix typos in description fields
+    - scalar.region updating description field
+    - updated ERM´s 
+
 ### Added
 
 ### Changed

diff --git a/oedatamodel/latest/v111/OEDataModel-concrete.er b/oedatamodel/latest/v111/OEDataModel-concrete.er
@@ -0,0 +1,49 @@
+[Scenario] {bgcolor: "#c1d6c1"}
+*'id (bigint)'
+'scenario (text)'
+'region (json)'
+'year (int)'
+'source (text)'
+'comment (text)'
+
+
+[Scalar] {bgcolor: "#b9d3eb"}
+*'id (bigint)'
++'scenario id (bigint)'
+'region (array(text))'
+'year (int)' 
+'input energy vector (text)'
+'output energy vector (text)'
+'parameter name (text)'
+'technology (text)'
+'technology type (text)'
+'value (decimal/float)'
+'unit (text)'
+'tags (json)'
+'method (json)'
+'source (text)'
+'comment (text)'
+
+Scenario 1--* Scalar
+
+[Timeseries] {bgcolor: "#b9d3eb"}
+*'id (bigint)'
++'scenario id (bigint)'
+'region (array(text))'
+'input energy vector (text)'
+'output energy vector (text)'
+'parameter name (text)'
+'technology (text)'
+'technology type (text)'
+'timeindex start (timestamp)'
+'timeindex stop (timestamp)'
+'timeindex resolution (intervall)'
+'series (array(decimal/float))'
+'unit (text)'
+'tags (json)'
+'method (json)'
+'source (text)'
+'comment (text)'
+
+Scenario 1--* Timeseries
+
diff --git a/...odel/latest/v110/OEDataModel-concrete.pdf → ...odel/latest/v111/OEDataModel-concrete.pdf b/...odel/latest/v110/OEDataModel-concrete.pdf → ...odel/latest/v111/OEDataModel-concrete.pdf
diff --git a/oedatamodel/latest/v111/OEDataModel-normalization.er b/oedatamodel/latest/v111/OEDataModel-normalization.er
@@ -0,0 +1,42 @@
+[Scenario] {bgcolor: "#c1d6c1"}
+*'id (bigint)'
+'scenario (text)'
+'region (json)'
+'year (int)'
+'source (text)'
+'comment (text)'
+
+Scenario 1--* Data
+
+[Data] {bgcolor: "#b9d3eb"}
+*'id (bigint)'
++'scenario id (bigint)'
+'region (array(text))' 
+'input energy vector (text)'
+'output energy vector (text)'
+'parameter name (text)'
+'technology (text)'
+'technology type (text)'
+'type (text ("scalar" | "timeseries"))'
+'unit (text)'
+'tags (json)'
+'method (json)'
+'source (text)'
+'comment (text)'
+
+Data 1--1 Scalar
+
+[Scalar] {bgcolor: "#b9d3eb"}
+*+'id (bigint)'
+'year (int)'
+'value (decimal/float)'
+
+Data 1--1 Timeseries
+
+[Timeseries] {bgcolor: "#b9d3eb"}
+*+'id (bigint)'
+'timeindex start (timestamp)'
+'timeindex stop (timestamp)'
+'timeindex resolution (intervall)'
+'series (array(decimal/float))'
+
diff --git a/...latest/v110/OEDataModel-normalization.pdf → ...latest/v111/OEDataModel-normalization.pdf b/...latest/v110/OEDataModel-normalization.pdf → ...latest/v111/OEDataModel-normalization.pdf
diff --git a/oedatamodel/latest/v110/README.md → oedatamodel/latest/v111/README.md b/oedatamodel/latest/v110/README.md → oedatamodel/latest/v111/README.md
diff --git a/...t/v111/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage.json b/...t/v111/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage.json
@@ -0,0 +1,162 @@
+{"name": "Oedatamodel readable - General Energy Modell Datapackage",
+"title": "OpenEnergyPlatform data format for scenario data in human readable format",
+"id": "",
+"description": "datamodel, metadata and examples provided as datapackage",
+"language": ["en-GB"],
+"keywords": ["datamodel", "datapackage", "genral energy dataformat"],
+"publicationDate": "2020-08-11",
+"context":
+    {"homepage": "https://openenergy-platform.org/",
+    "documentation": "https://github.com/OpenEnergyPlatform/oedatamodel/blob/develop/README.md",
+    "sourceCode": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest",
+    "contact": "",
+    "grantNo": "",
+    "fundingAgency": "",
+    "fundingAgencyLogo": "",
+    "publisherLogo": ""},
+"spatial":
+    {"location": "",
+    "extent": "",
+    "resolution": ""},
+"temporal": 
+    {"referenceDate": "",
+    "timeseries": 
+        {"start": "",
+        "end": "",
+        "resolution": "",
+        "alignment": "",
+        "aggregationType": ""} },
+"sources": [
+    {
+        "title": "Open energy datamodel",
+        "description": "oedatamodel for energy model data",
+        "path": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel",
+        "licenses": [
+            {
+                "name": "CC0-1.0",
+                "title": "Creative Commons Zero v1.0 Universal",
+                "path": "https://creativecommons.org/publicdomain/zero/1.0/legalcode",
+                "instruction": "You are free: To Share, To Create, To Adapt",
+                "attribution": "© Reiner Lemoine Institut"
+            }
+        ]
+    }],
+"licenses": [
+    {
+        "name": "",
+        "title": "",
+        "path": "",
+        "instruction": "",
+        "attribution": ""
+    } 
+],
+"contributors": [
+    {"title": "jh-RLI", "email": null, "date": "2020-08-11", "object": "datapackage", "comment": "Create template datapackage for oedatamodel"},
+    {"title": "jh-RLI", "email": null, "date": "2020-10-08", "object": "metadata", "comment": "Fix links to documentation and source code"},
+    {"title": "jh-RLI", "email": null, "date": "2020-11-08", "object": "metadata", "comment": "Update Ressources"} ],
+"resources": [
+    {"profile": "tabular-data-resource",
+    "name": "oed_concrete_scenario",
+    "path": "OEDataModel-concrete_scenario.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, you can add a upper region with sub regions using json syntax", "type": "json", "unit": null},
+            {"name": "year", "description": "Year", "type": "integer", "unit": null},
+            {"name": "source", "description": "Source", "type": "text", "unit": null},
+            {"name": "comment", "description": "Comment", "type": "text", "unit": null} ],
+        "primaryKey": ["id"],
+        "foreignKeys": [{
+                "fields": [null],
+                "reference": {
+                    "resource": null,
+                    "fields": [null] } } ] },
+    "dialect":
+        {"delimiter": ";",
+        "decimalSeparator": "."} },
+
+    {"profile": "tabular-data-resource",
+    "name": "oed_concrete_scalar",
+    "path": "OEDataModel-concrete_scalar.csv",
+    "format": "csv",
+    "encoding" : "UTF-8",
+    "schema": {
+        "fields": [
+            {"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
+            {"name": "scenario_id", "description": "Scenario name", "type": "bigint", "unit": null},
+            {"name": "region", "description": "Country or region, add a flow from region a -> b: ['a', 'b']", "type": "text array", "unit": null},
+            {"name": "year", "description": "Year", "type": "integer", "unit": null},
+            {"name": "input_energy_vector", "description": "It describes any type of energy or energy carrier (e.g. electricity, heat, solar radiation, natural gas, ...) that enters a technology.", "type": "text", "unit": null},
+            {"name": "output_energy_vector", "description": "It describes any type of energy or energy carrier (e.g. electricity, heat, hydrogen, LNG, CO2, ...) that exits a technology.", "type": "text", "unit": null},
+            {"name": "parameter_name", "description": "It describes a considered property of an element in the energy system.", "type": "text", "unit": null},
+            {"name": "technology", "description": "It describes an element of the modelled energy system that processes an energy vector.", "type": "text", "unit": null},
+            {"name": "technology_type", "description": "The specification can be technological, or freely user-defined, based on the requirements of the model.", "type": "text", "unit": null},
+            {"name": "value", "description": "Parameter value", "type": "decimal", "unit": "kW"},
+            {"name": "unit", "description": "Parameter unit", "type": "text", "unit": null},
+            {"name": "tags", "description": "Free classification with key-value pairs", "type": "json", "unit": null},
+            {"name": "method", "description": "Method type (sum, mean, median)", "type": "json", "unit": null},
+            {"name": "source", "description": "Source", "type": "text", "unit": null},
+            {"name": "comment", "description": "Comment", "type": "text", "unit": null} ],
+        "primaryKey": ["id"],
+        "foreignKeys": [{
+                "fields": ["scenario_id"],
+                "reference": {
+                    "resource": "oed_concrete_scenari",
+                    "fields": ["id"] } } ] },
+    "dialect":
+        {"delimiter": ";",
+        "decimalSeparator": "."} },
+        {"profile": "tabular-data-resource",
+            "name": "oed_concrete_timeseries",
+            "path": "OEDataModel-concrete_timeseries.csv",
+            "format": "csv",
+            "encoding" : "UTF-8",
+            "schema": {
+                "fields": [
+                    {"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                    {"name": "scenario_id", "description": "Scenario name", "type": "bigint", "unit": null},
+                    {"name": "region", "description": "Country or region", "type": "text array", "unit": null},
+                    {"name": "input_energy_vector", "description": "It describes any type of energy or energy carrier (e.g. electricity, heat, solar radiation, natural gas, ...) that enters a technology.", "type": "text", "unit": null},
+                    {"name": "output_energy_vector", "description": "It describes any type of energy or energy carrier (e.g. electricity, heat, hydrogen, LNG, CO2, ...) that exits a technology.", "type": "text", "unit": null},
+                    {"name": "parameter_name", "description": "It describes a considered property of an element in the energy system.", "type": "text", "unit": null},
+                    {"name": "technology", "description": "It describes an element of the modelled energy system that processes an energy vector.", "type": "text", "unit": null},
+                    {"name": "technology_type", "description": "The specification can be technological, or freely user-defined, based on the requirements of the model.", "type": "text", "unit": null},
+                    {"name": "timeindex_start", "description": "Start timestamp", "type": "timestamp", "unit": null},
+                    {"name": "timeindex_stop", "description": "Stop timestamp", "type": "timestamp", "unit": null},
+                    {"name": "timeindex_resolution", "description": "Timesteps", "type": "interval", "unit": null},
+                    {"name": "series", "description": "Timesteps", "type": "float array", "unit": null},
+                    {"name": "unit", "description": "Parameter unit", "type": "text", "unit": null},
+                    {"name": "tags", "description": "Free classification with key-value pairs", "type": "json", "unit": null},
+                    {"name": "method", "description": "Method type (sum, mean, median)", "type": "json", "unit": null},
+                    {"name": "source", "description": "Source", "type": "text", "unit": null},
+                    {"name": "comment", "description": "Comment", "type": "text", "unit": null} ],
+                "primaryKey": ["id"],
+                "foreignKeys": [{
+                        "fields": ["scenario_id"],
+                        "reference": {
+                            "resource": "oed_concrete_scenari",
+                            "fields": ["id"] } } ] },
+            "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)"} }
diff --git a/...DataModel-concrete-datapackage_scalar.csv → ...DataModel-concrete-datapackage_scalar.csv b/...DataModel-concrete-datapackage_scalar.csv → ...DataModel-concrete-datapackage_scalar.csv
diff --git a/...taModel-concrete-datapackage_scenario.csv → ...taModel-concrete-datapackage_scenario.csv b/...taModel-concrete-datapackage_scenario.csv → ...taModel-concrete-datapackage_scenario.csv
diff --git a/...Model-concrete-datapackage_timeseries.csv → ...Model-concrete-datapackage_timeseries.csv b/...Model-concrete-datapackage_timeseries.csv → ...Model-concrete-datapackage_timeseries.csv