Merge pull request #35 from open-modex/release/oedatamodel-v1.1.0

Release/oedatamodel v1.1.0

CHANGELOG.md

@@ -28,12 +28,21 @@ Here is a template for new release sections
 ```
 ## Current
 
+### Added
+
+### Changed
+
+
+## [1.1.0] 
+
 ### Added
 - Improve description for each posssible table (column)
 - Provide table examples 
 
 ### Changed
--
+- Change OEDataModel Primary Key column names to "id" to support OEP API requirments [PR#30]
+- Added new 'year' column to scalar table model [Issue#29]
+- Updated ERM with datamodel changes 
 
 
 ## [1.0.0] Initial release

README.md

@@ -13,10 +13,10 @@ Additional we include a datapackage for every release.
 Existing approaches and ideas such as the [IAMC data format](https://github.com/IAMconsortium/pyam#data-model) or [Do-a-thon: Towards a common data standard 
 for integrated assessment and energy systems modelling](https://forum.openmod-initiative.org/t/do-a-thon-towards-a-common-data-standard-for-integrated-assessment-and-energy-systems-modelling/1774/5) were adopted in the development process.
 
-The latest version can be found in the folder oedatamodel/latest. 
-The version available there offers the user 2 ERM's. The ERM "oedatamodel.pdf" shows the data model 
+The latest version can be found in the folder [oedatamodel/latest](https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest). 
+The version available there offers the user 2 ERM's. The ERM "OEDataModel-normalization.pdf" shows the data model 
 that can be implemented on a database (e.g. postgresql). Here tables, relations, column names and 
-data types are provided. The ERM "oedatamodel-readable.pdf" is provided additionally and is designed 
+data types are provided. The ERM "OEDataModel-concrete.pdf" is provided additionally and is designed 
 to simplify the editing of the data by a user. It also provides tables and relations as well as column 
 names and datatypes, but the tables are in a less normalized format. We recommend this version of the 
 data model for the implementation in e.g. csv tables because the advantage of the more human usable format 

oedatamodel/latest/v100/OEDataModel-concrete.er → oedatamodel/latest/v110/OEDataModel-concrete.er

@@ -1,5 +1,5 @@
 [Scenario] {bgcolor: "#c1d6c1"}
-*'scenario id (int)'
+*'id (bigint)'
 'scenario (text)'
 'region (array(text))'
 'year (int)'
@@ -8,10 +8,10 @@
 
 
 [Scalar] {bgcolor: "#b9d3eb"}
-*'scalar id (int)'
-+'scenario id (int)'
-'region (array(text))' 
-'year(int)' <--- Ist das hier gut?
+*'id (bigint)'
++'scenario id (bigint)'
+'region (array(text))'
+'year (int)' 
 'input energy vector (text)'
 'output energy vector (text)'
 'parameter name (text)'
@@ -27,8 +27,8 @@
 Scenario 1--* Scalar
 
 [Timeseries] {bgcolor: "#b9d3eb"}
-*'timeseries id (int)'
-+'scenario id (int)'
+*'id (bigint)'
++'scenario id (bigint)'
 'region (array(text))'
 'input energy vector (text)'
 'output energy vector (text)'

oedatamodel/latest/v100/OEDataModel-normalization.er → oedatamodel/latest/v110/OEDataModel-normalization.er

@@ -1,5 +1,5 @@
 [Scenario] {bgcolor: "#c1d6c1"}
-*'scenario id (int)'
+*'id (bigint)'
 'scenario (text)'
 'region (array(text))'
 'year (int)'
@@ -9,8 +9,8 @@
 Scenario 1--* Data
 
 [Data] {bgcolor: "#b9d3eb"}
-*'data id (int)'
-+'scenario id (int)'
+*'id (bigint)'
++'scenario id (bigint)'
 'region (array(text))' 
 'input energy vector (text)'
 'output energy vector (text)'
@@ -27,14 +27,14 @@ Scenario 1--* Data
 Data 1--1 Scalar
 
 [Scalar] {bgcolor: "#b9d3eb"}
-*+'data id (int)'
-'year (int)' <--- Ist das hier gut?
+*+'id (bigint)'
+'year (int)'
 'value (decimal/float)'
 
 Data 1--1 Timeseries
 
 [Timeseries] {bgcolor: "#b9d3eb"}
-*+'data id (int)'
+*+'id (bigint)'
 'timeindex start (timestamp)'
 'timeindex stop (timestamp)'
 'timeindex resolution (intervall)'

oedatamodel/latest/v100/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage.json → oedatamodel/latest/v110/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage.json

@@ -7,8 +7,8 @@
 "publicationDate": "2020-08-11",
 "context":
     {"homepage": "https://openenergy-platform.org/",
-    "documentation": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest/v100/oedatamodel-readable.pdf",
-    "sourceCode": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest/v100/oedatamodel-readable.er",
+    "documentation": "https://github.com/OpenEnergyPlatform/oedatamodel/blob/develop/README.md",
+    "sourceCode": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest",
     "contact": "",
     "grantNo": "",
     "fundingAgency": "",
@@ -52,22 +52,22 @@
 ],
 "contributors": [
     {"title": "jh-RLI", "email": null, "date": "2020-08-11", "object": "datapackage", "comment": "Create template datapackage for oedatamodel"},
-    {"title": "", "email": "", "date": "", "object": "", "comment": ""} ],
+    {"title": "jh-RLI", "email": null, "date": "2020-10-08", "object": "metadata", "comment": "Fix links to documentation and source code"} ],
 "resources": [
     {"profile": "tabular-data-resource",
-    "name": "model_draft.oed_concrete_scenario",
+    "name": "oed_concrete_scenario",
     "path": "OEDataModel-concrete_scenario.csv",
     "format": "csv",
     "encoding" : "UTF-8",
     "schema": {
         "fields": [
-            {"name": "scenario_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+            {"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 array", "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": ["scenario_id"],
+        "primaryKey": ["id"],
         "foreignKeys": [{
                 "fields": [null],
                 "reference": {
@@ -78,15 +78,16 @@
         "decimalSeparator": "."} },
 
     {"profile": "tabular-data-resource",
-    "name": "model_draft.oed_concrete_scalar",
+    "name": "oed_concrete_scalar",
     "path": "OEDataModel-concrete_scalar.csv",
     "format": "csv",
     "encoding" : "UTF-8",
     "schema": {
         "fields": [
-            {"name": "scalar_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+            {"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": "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},
@@ -98,23 +99,23 @@
             {"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": ["scalar_id"],
+        "primaryKey": ["id"],
         "foreignKeys": [{
                 "fields": ["scenario_id"],
                 "reference": {
-                    "resource": "model_draft.oed_concrete_scenario",
-                    "fields": ["scenario_id"] } } ] },
+                    "resource": "oed_concrete_scenari",
+                    "fields": ["id"] } } ] },
     "dialect":
         {"delimiter": ";",
         "decimalSeparator": "."} },
         {"profile": "tabular-data-resource",
-            "name": "model_draft.oed_concrete_timeseries",
+            "name": "oed_concrete_timeseries",
             "path": "OEDataModel-concrete_timeseries.csv",
             "format": "csv",
             "encoding" : "UTF-8",
             "schema": {
                 "fields": [
-                    {"name": "timeseries_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                    {"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},
@@ -131,12 +132,12 @@
                     {"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": ["timeseries_id"],
+                "primaryKey": ["id"],
                 "foreignKeys": [{
                         "fields": ["scenario_id"],
                         "reference": {
-                            "resource": "model_draft.oed_concrete_scenario",
-                            "fields": ["scenario_id"] } } ] },
+                            "resource": "oed_concrete_scenari",
+                            "fields": ["id"] } } ] },
             "dialect":
                 {"delimiter": ";",
                 "decimalSeparator": "."} } ],

oedatamodel/latest/v110/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage_scalar.csv

@@ -0,0 +1 @@
+id;scenario_id;region;year;input_energy_vector;output_energy_vector;parameter_name;technology;technology_type;value;unit;tags;method;source;comment

oedatamodel/latest/v110/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage_scenario.csv

@@ -0,0 +1 @@
+id;scenario;region;year;source;comment

oedatamodel/latest/v110/datapackage/OEDataModel-concrete-datapackage/OEDataModel-concrete-datapackage_timeseries.csv

@@ -0,0 +1 @@
+id;scenario_id;region;input_energy_vector;output_energy_vector;parameter_name;technology;technology_type;timeindex_start;timeindex_stop;timeindex_resolution;series;unit;tags;method;source;comment

oedatamodel/latest/v100/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage.json → oedatamodel/latest/v110/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage.json

@@ -7,8 +7,8 @@
     "publicationDate": "2020-08-11",
     "context":
         {"homepage": "https://openenergy-platform.org/",
-        "documentation": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest/v100/oedatamodel.pdf",
-        "sourceCode": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest/v100/oedatamodel.er",
+        "documentation": "https://github.com/OpenEnergyPlatform/oedatamodel/blob/develop/README.md",
+        "sourceCode": "https://github.com/OpenEnergyPlatform/oedatamodel/tree/develop/oedatamodel/latest",
         "contact": "",
         "grantNo": "",
         "fundingAgency": "",
@@ -52,7 +52,7 @@
     ],
     "contributors": [
         {"title": "jh-RLI", "email": null, "date": "2020-08-11", "object": "datapackage", "comment": "Create template datapackage for oedatamodel"},
-        {"title": "", "email": "", "date": "", "object": "", "comment": ""} ],
+        {"title": "jh-RLI", "email": null, "date": "2020-10-08", "object": "metadata", "comment": "Fix links to documentation and source code"} ],
     "resources": [
         {"profile": "tabular-data-resource",
         "name": "model_draft.oed_scenario",
@@ -61,13 +61,13 @@
         "encoding" : "UTF-8",
         "schema": {
             "fields": [
-                {"name": "scenario_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                {"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 array", "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": ["scenario_id"],
+            "primaryKey": ["id"],
             "foreignKeys": [{
                     "fields": [null],
                     "reference": {
@@ -84,7 +84,7 @@
         "encoding" : "UTF-8",
         "schema": {
             "fields": [
-                {"name": "data_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                {"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},
@@ -98,12 +98,12 @@
                 {"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": ["data_id"],
+            "primaryKey": ["id"],
             "foreignKeys": [{
                     "fields": ["scenario_id"],
                     "reference": {
                         "resource": "model_draft.oed_scenario",
-                        "fields": ["scenario_id"] } } ] },
+                        "fields": ["id"] } } ] },
 
         "dialect":
             {"delimiter": ";",
@@ -116,14 +116,15 @@
         "encoding" : "UTF-8",
         "schema": {
             "fields": [
-                {"name": "data_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                {"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                {"name": "year", "description": "Year", "type": "integer", "unit": null},
                 {"name": "value", "description": "Value", "type": "float", "unit": "kw"} ],
-            "primaryKey": ["data_id"],
+            "primaryKey": ["id"],
             "foreignKeys": [{
-                    "fields": ["data_id"],
+                    "fields": ["id"],
                     "reference": {
                         "resource": "model_draft.oed_data",
-                        "fields": ["data_id"] } } ] },
+                        "fields": ["id"] } } ] },
         "dialect":
             {"delimiter": ";",
             "decimalSeparator": "."} },
@@ -135,17 +136,17 @@
             "encoding" : "UTF-8",
             "schema": {
                 "fields": [
-                    {"name": "data_id", "description": "Unique identifier", "type": "bigint", "unit": null},
+                    {"name": "id", "description": "Unique identifier", "type": "bigint", "unit": null},
                     {"name": "timeindex_start", "description": "Start timestemp", "type": "timestamp", "unit": null},
                     {"name": "timeindex_stop", "description": "Stop timestemp", "type": "timestamp", "unit": null},
                     {"name": "timeindex_resolution", "description": "Timesteps", "type": "interval", "unit": null},
                     {"name": "series", "description": "Timesteps", "type": "float array", "unit": null} ],
                 "primaryKey": ["data_id"],
                 "foreignKeys": [{
-                        "fields": ["data_id"],
+                        "fields": ["id"],
                         "reference": {
                             "resource": "model_draft.oed_data",
-                            "fields": ["data_id"] } } ] },
+                            "fields": ["id"] } } ] },
             "dialect":
                 {"delimiter": ";",
                 "decimalSeparator": "."} } ],

oedatamodel/latest/v110/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage_data.csv

@@ -0,0 +1 @@
+id;scenario_id;region;input_energy_vector;output_energy_vector;parameter_name;technology;technology_type;type;unit;tags;method;source;comment

oedatamodel/latest/v110/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage_scalar.csv

@@ -0,0 +1 @@
+id;year;value

oedatamodel/latest/v110/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage_scenario.csv

@@ -0,0 +1 @@
+id;scenario;region;year;source;comment

oedatamodel/latest/v110/datapackage/OEDataModel-normalization-datapackage/OEDataModel-normalization-datapackage_timeseries.csv

@@ -0,0 +1 @@
+id;timeindex_start;timeindex_stop;timeindex_resolution;series