Skip to content

V1.4 release #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 9, 2019
Merged

V1.4 release #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
92bd8c3
Replace none with null #54
christian-rli Jul 2, 2019
663b20d
Replace fundingAuthority with fundingAgency #32
christian-rli Jul 2, 2019
1d035d2
Add aggregationType #22
christian-rli Jul 2, 2019
59e3712
Restructure temporal class to include timeseries #22
christian-rli Jul 4, 2019
71fc35e
Clear out template file
christian-rli Jul 4, 2019
e4fc93c
Add publisherLogo #57
christian-rli Jul 4, 2019
8a158a3
Replace "null" with null #54
christian-rli Jul 8, 2019
82483f7
update metadata version id #58
Ludee Jul 9, 2019
2354f2e
update metadata source licenses #58
Ludee Jul 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 46 additions & 34 deletions metadata/oep_metadata_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,51 +10,63 @@
"documentation": "https://github.com/OpenEnergyPlatform/organisation/wiki/metadata",
"sourceCode": "https://github.com/OpenEnergyPlatform/examples/tree/master/metadata",
"contact": "https://github.com/Ludee",
"fundingAuthority": "Bundesministerium für Wirtschaft und Energie",
"fundingAuthorityLogo": "https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=poster&v=2",
"grantNo": "03ET4057"},
"grantNo": "03ET4057",
"fundingAgency": "Bundesministerium für Wirtschaft und Energie",
"fundingAgencyLogo": "https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=poster&v=2",
"publisherLogo": "https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png"},
"spatial":
{"location": "none",
{"location": null,
"extent": "europe",
"resolution": "100 m"},
"temporal":
{"referenceDate": "2016-01-01",
"start": "2017-01-01T00:00+01",
"end": "2017-12-31T23:00+01",
"resolution": "1 h",
"timestamp": "left"},
"timeseries":
{"start": "2017-01-01T00:00+01",
"end": "2017-12-31T23:00+01",
"resolution": "1 h",
"alignment": "left",
"aggregationType": "sum"} },
"sources": [
{"title": "OpenEnergyPlatform Metadata Example",
"description": "Metadata description",
"path": "https://github.com/OpenEnergyPlatform",
"license": "Creative Commons Zero v1.0 Universal (CC0-1.0)",
"copyright": "© Reiner Lemoine Institut"},
"path": "https://github.com/OpenEnergyPlatform",
"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"} ] },
{"title": "OpenStreetMap",
"description": "A collaborative project to create a free editable map of the world",
"path": "https://www.openstreetmap.org/",
"license": "ODbL-1.0",
"copyright": "© OpenStreetMap contributors"} ],
"licenses": [
{"name": "ODbL-1.0",
"title": "Open Data Commons Open Database License 1.0",
"path": "https://opendatacommons.org/licenses/odbl/1.0/index.html",
"instruction": "You are free: To Share, To Create, To Adapt; As long as you: Attribute, Share-Alike, Keep open!",
"attribution": "© OpenStreetMap contributors"} ] } ],
"licenses": [
{"name": "ODbL-1.0",
"title": "Open Data Commons Open Database License 1.0",
"path": "https://opendatacommons.org/licenses/odbl/1.0/",
"instruction": "You are free: To Share, To Create, To Adapt; As long as you: Attribute, Share-Alike, Keep open!",
"attribution": "© Reiner Lemoine Institut"}],
"attribution": "© Reiner Lemoine Institut © OpenStreetMap contributors"}],
"contributors": [
{"title": "Ludee", "email": "none", "date": "2016-06-16", "object": "metadata", "comment": "Create metadata"},
{"title": "Ludee", "email": "none", "date": "2016-11-22", "object": "metadata", "comment": "Update metadata"},
{"title": "Ludee", "email": "none", "date": "2016-11-22", "object": "metadata", "comment": "Update header and license"},
{"title": "Ludee", "email": "none", "date": "2017-03-16", "object": "metadata", "comment": "Add license to source"},
{"title": "Ludee", "email": "none", "date": "2017-03-28", "object": "metadata", "comment": "Add copyright to source and license"},
{"title": "Ludee", "email": "none", "date": "2017-05-30", "object": "metadata", "comment": "Release metadata version 1.3"},
{"title": "Ludee", "email": "none", "date": "2017-06-26", "object": "metadata", "comment": "Move referenceDate into temporal and remove array"},
{"title": "Ludee", "email": "none", "date": "2018-07-19", "object": "metadata", "comment": "Start metadata version 1.4"},
{"title": "Ludee", "email": "none", "date": "2018-07-26", "object": "data", "comment": "Rename table and files"},
{"title": "Ludee", "email": "none", "date": "2018-10-18", "object": "metadata", "comment": "Add contribution object"},
{"title": "christian-rli", "email": "none", "date": "2018-10-18", "object": "metadata", "comment": "Add datapackage compatibility"},
{"title": "Ludee", "email": "none", "date": "2018-11-02", "object": "metadata", "comment": "Release metadata version 1.4"},
{"title": "christian-rli", "email": "none", "date": "2019-02-05", "object": "metadata", "comment": "Apply template structure to example."},
{"title": "Ludee", "email": "none", "date": "2019-03-22", "object": "metadata", "comment": "Hotfix foreignKeys"} ],
{"title": "Ludee", "email": null, "date": "2016-06-16", "object": "metadata", "comment": "Create metadata"},
{"title": "Ludee", "email": null, "date": "2016-11-22", "object": "metadata", "comment": "Update metadata"},
{"title": "Ludee", "email": null, "date": "2016-11-22", "object": "metadata", "comment": "Update header and license"},
{"title": "Ludee", "email": null, "date": "2017-03-16", "object": "metadata", "comment": "Add license to source"},
{"title": "Ludee", "email": null, "date": "2017-03-28", "object": "metadata", "comment": "Add copyright to source and license"},
{"title": "Ludee", "email": null, "date": "2017-05-30", "object": "metadata", "comment": "Release metadata version 1.3"},
{"title": "Ludee", "email": null, "date": "2017-06-26", "object": "metadata", "comment": "Move referenceDate into temporal and remove array"},
{"title": "Ludee", "email": null, "date": "2018-07-19", "object": "metadata", "comment": "Start metadata version 1.4"},
{"title": "Ludee", "email": null, "date": "2018-07-26", "object": "data", "comment": "Rename table and files"},
{"title": "Ludee", "email": null, "date": "2018-10-18", "object": "metadata", "comment": "Add contribution object"},
{"title": "christian-rli", "email": null, "date": "2018-10-18", "object": "metadata", "comment": "Add datapackage compatibility"},
{"title": "Ludee", "email": null, "date": "2018-11-02", "object": "metadata", "comment": "Release metadata version 1.4"},
{"title": "christian-rli", "email": null, "date": "2019-02-05", "object": "metadata", "comment": "Apply template structure to example"},
{"title": "Ludee", "email": null, "date": "2019-03-22", "object": "metadata", "comment": "Hotfix foreignKeys"},
{"title": "Ludee", "email": null, "date": "2019-07-09", "object": "metadata", "comment": "Release metadata version OEP-1.3.0"} ],
"resources": [
{"profile": "tabular-data-resource",
"name": "model_draft.oep_metadata_table_example_v14",
Expand All @@ -63,24 +75,24 @@
"encoding" : "UTF-8",
"schema": {
"fields": [
{"name": "id", "description": "Unique identifier", "type": "serial", "unit": "none"},
{"name": "year", "description": "Reference year", "type": "integer", "unit": "none"},
{"name": "id", "description": "Unique identifier", "type": "serial", "unit": null},
{"name": "year", "description": "Reference year", "type": "integer", "unit": null},
{"name": "value", "description": "Example value", "type": "double precision", "unit": "MW"},
{"name": "geom", "description": "Geometry", "type": "geometry(Point, 4326)", "unit": "none"} ],
{"name": "geom", "description": "Geometry", "type": "geometry(Point, 4326)", "unit": null} ],
"primaryKey": ["id"],
"foreignKeys": [{
"fields": ["year"],
"reference": {
"resource": "schema.table",
"fields": ["year"] } } ] },
"dialect":
{"delimiter": "none",
{"delimiter": null,
"decimalSeparator": "."} } ],
"review": {
"path": "https://github.com/OpenEnergyPlatform/data-preprocessing/wiki",
"badge": "platin"},
"metaMetadata":
{"metadataVersion": "OEP-1.4",
{"metadataVersion": "OEP-1.4.0",
"metadataLicense":
{"name": "CC0-1.0",
"title": "Creative Commons Zero v1.0 Universal",
Expand All @@ -92,4 +104,4 @@
"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)",
"none": "If not applicable use (none)"} }
"null": "If not applicable use (null)"} }
118 changes: 69 additions & 49 deletions metadata/oep_metadata_example.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Additional information:
- Dates and time must follow the ISO8601 (JJJJ-MM-TT; 1 a; 1 h)
- Use a space between Numbers and units (100 m)
- Languages must follow the IETF (BCP47) format (en-US; de-DE)
- If not applicable use "none"
- If not applicable use null
*/

-- table
Expand All @@ -39,57 +39,69 @@ COMMENT ON TABLE model_draft.oep_metadata_table_example_v14 IS '
"description": "example metadata for example data",
"language": [ "en-GB", "en-US", "de-DE", "fr-FR" ],
"keywords": [ "example", "template", "test" ],
"publication_date": "2018-06-12",
"publicationDate": "2018-06-12",
"context":
{"homepage": "https://reiner-lemoine-institut.de/szenariendb/",
"documentation": "https://github.com/OpenEnergyPlatform/organisation/wiki/metadata",
"source_code": "https://github.com/OpenEnergyPlatform/examples/tree/master/metadata",
"sourceCode": "https://github.com/OpenEnergyPlatform/examples/tree/master/metadata",
"contact": "https://github.com/Ludee",
"fundingAuthority": "Bundesministerium für Wirtschaft und Energie",
"fundingAuthorityLogo": "https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=poster&v=2",
"grant_no": "03ET4057"},
"grantNo": "03ET4057",
"fundingAgency": "Bundesministerium für Wirtschaft und Energie",
"fundingAgencyLogo": "https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=poster&v=2",
"publisherLogo": "https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png"},
"spatial":
{"location": "none",
{"location": null,
"extent": "europe",
"resolution": "100 m"},
"temporal":
{"reference_date": "2016-01-01",
"start": "2017-01-01T00:00+01",
"end": "2017-12-31T23:00+01",
"resolution": "1 h"
"timestamp": "left"},
{"referenceDate": "2016-01-01",
"timeseries":
{"start": "2017-01-01T00:00+01",
"end": "2017-12-31T23:00+01",
"resolution": "1 h",
"alignment": "left",
"aggregationType": "sum"} },
"sources": [
{"title": "OpenEnergyPlatform Metadata Example",
"description": "Metadata description",
"url": "https://github.com/OpenEnergyPlatform",
"license": "Creative Commons Zero v1.0 Universal (CC0-1.0)",
"copyright": "© Reiner Lemoine Institut"},
"path": "https://github.com/OpenEnergyPlatform",
"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"} ] },
{"title": "OpenStreetMap",
"description": "A collaborative project to create a free editable map of the world",
"url": "https://www.openstreetmap.org/",
"license": "ODbL-1.0",
"copyright": "© OpenStreetMap contributors"} ],
"path": "https://www.openstreetmap.org/",
"licenses": [
{"name": "ODbL-1.0",
"title": "Open Data Commons Open Database License 1.0",
"path": "https://opendatacommons.org/licenses/odbl/1.0/index.html",
"instruction": "You are free: To Share, To Create, To Adapt; As long as you: Attribute, Share-Alike, Keep open!",
"attribution": "© OpenStreetMap contributors"} ] } ],
"licenses": [
{"id": "ODbL-1.0",
{"name": "ODbL-1.0",
"title": "Open Data Commons Open Database License 1.0",
"url": "https://opendatacommons.org/licenses/odbl/1.0/",
"path": "https://opendatacommons.org/licenses/odbl/1.0/",
"instruction": "You are free: To Share, To Create, To Adapt; As long as you: Attribute, Share-Alike, Keep open!",
"copyright": "© Reiner Lemoine Institut"}],
"attribution": "© Reiner Lemoine Institut © OpenStreetMap contributors"}],
"contributors": [
{"title": "Ludee", "email": "none", "date": "2016-06-16", "object": "metadata", "comment": "Create metadata"},
{"title": "Ludee", "email": "none", "date": "2016-11-22", "object": "metadata", "comment": "Update metadata"},
{"title": "Ludee", "email": "none", "date": "2016-11-22", "object": "metadata", "comment": "Update header and license"},
{"title": "Ludee", "email": "none", "date": "2017-03-16", "object": "metadata", "comment": "Add license to source"},
{"title": "Ludee", "email": "none", "date": "2017-03-28", "object": "metadata", "comment": "Add copyright to source and license"},
{"title": "Ludee", "email": "none", "date": "2017-05-30", "object": "metadata", "comment": "Release metadata version 1.3"},
{"title": "Ludee", "email": "none", "date": "2017-06-26", "object": "metadata", "comment": "Move reference_date into temporal and remove array"},
{"title": "Ludee", "email": "none", "date": "2018-07-19", "object": "metadata", "comment": "Start metadata version 1.4"},
{"title": "Ludee", "email": "none", "date": "2018-07-26", "object": "data", "comment": "Rename table and files"},
{"title": "Ludee", "email": "none", "date": "2018-10-18", "object": "metadata", "comment": "Add contribution object"},
{"title": "christian-rli", "email": "none", "date": "2018-10-18", "object": "metadata", "comment": "Add datapackage compatibility"},
{"title": "Ludee", "email": "none", "date": "2018-11-02", "object": "metadata", "comment": "Release metadata version 1.4"},
{"title": "christian-rli", "email": "none", "date": "2019-02-05", "object": "metadata", "comment": "Apply template structure to example."},
{"title": "Ludee", "email": "none", "date": "2019-03-22", "object": "metadata", "comment": "Hotfix foreignKeys"} ],
{"title": "Ludee", "email": null, "date": "2016-06-16", "object": "metadata", "comment": "Create metadata"},
{"title": "Ludee", "email": null, "date": "2016-11-22", "object": "metadata", "comment": "Update metadata"},
{"title": "Ludee", "email": null, "date": "2016-11-22", "object": "metadata", "comment": "Update header and license"},
{"title": "Ludee", "email": null, "date": "2017-03-16", "object": "metadata", "comment": "Add license to source"},
{"title": "Ludee", "email": null, "date": "2017-03-28", "object": "metadata", "comment": "Add copyright to source and license"},
{"title": "Ludee", "email": null, "date": "2017-05-30", "object": "metadata", "comment": "Release metadata version 1.3"},
{"title": "Ludee", "email": null, "date": "2017-06-26", "object": "metadata", "comment": "Move referenceDate into temporal and remove array"},
{"title": "Ludee", "email": null, "date": "2018-07-19", "object": "metadata", "comment": "Start metadata version 1.4"},
{"title": "Ludee", "email": null, "date": "2018-07-26", "object": "data", "comment": "Rename table and files"},
{"title": "Ludee", "email": null, "date": "2018-10-18", "object": "metadata", "comment": "Add contribution object"},
{"title": "christian-rli", "email": null, "date": "2018-10-18", "object": "metadata", "comment": "Add datapackage compatibility"},
{"title": "Ludee", "email": null, "date": "2018-11-02", "object": "metadata", "comment": "Release metadata version 1.4"},
{"title": "christian-rli", "email": null, "date": "2019-02-05", "object": "metadata", "comment": "Apply template structure to example"},
{"title": "Ludee", "email": null, "date": "2019-03-22", "object": "metadata", "comment": "Hotfix foreignKeys"},
{"title": "Ludee", "email": null, "date": "2019-07-09", "object": "metadata", "comment": "Release metadata version OEP-1.3.0"} ],
"resources": [
{"profile": "tabular-data-resource",
"name": "model_draft.oep_metadata_table_example_v14",
Expand All @@ -98,28 +110,36 @@ COMMENT ON TABLE model_draft.oep_metadata_table_example_v14 IS '
"encoding" : "UTF-8",
"schema": {
"fields": [
{"name": "id", "description": "Unique identifier", "type": "serial", "unit": "none"},
{"name": "year", "description": "Reference year", "type": "integer", "unit": "none"},
{"name": "id", "description": "Unique identifier", "type": "serial", "unit": null},
{"name": "year", "description": "Reference year", "type": "integer", "unit": null},
{"name": "value", "description": "Example value", "type": "double precision", "unit": "MW"},
{"name": "geom", "description": "Geometry", "type": "geometry(Point, 4326)", "unit": "none"} ],
{"name": "geom", "description": "Geometry", "type": "geometry(Point, 4326)", "unit": null} ],
"primaryKey": ["id"],
"foreignKeys": [{
"fields": ["year"],
"reference": {
"resource": "schema.table",
"fields": ["year"] } } ] },
"dialect":
{"delimiter": "none",
"decimal_separator": "."} } ],
"_comment": {
"_metadata_version": "1.4",
"_metadata_license": "Creative Commons Zero v1.0 Universal (CC0-1.0)",
"_metadata_license_url": "https://creativecommons.org/publicdomain/zero/1.0/",
"_additional_information": {
"_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-US; de-DE)",
"_none": "If not applicable use (none)"} } }';
{"delimiter": null,
"decimalSeparator": "."} } ],
"review": {
"path": "https://github.com/OpenEnergyPlatform/data-preprocessing/wiki",
"badge": "platin"},
"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)"} }';

-- format verification
SELECT obj_description('model_draft.oep_metadata_table_example_v14' ::regclass) ::json;
Expand Down
Loading