[metadata] Collect ideas and feedback for next metadata version

[Ludee]

There will be a next metadata version (v1.4) for the OEP. The current version is v1.3.

This issue will be used to collect metadata feedback.

• [x] include open license (PD) for the metadata (see openmod forum)
• [x] change language entries to (see openmod forum thread)
• [x] tags/ keywords must be included
• [x] add unique identifier
• [x] check and include GO FAIR Principles
• [x] include info about data review (Link to issue, Reviewer, see https://github.com/OpenEnergyPlatform/data-preprocessing/issues/2 )

[Ludee]

Going through my list of existing metadata standards I came across DCAT-AP, which was mentioned a lot at the RDA conference 2018 in Berlin.

Documentation http://www.dcat-ap.de/def/dcatde/1.0.1/implRules.pdf http://www.dcat-ap.de/def/dcatde/1.0.1/spec/specification.pdf

EC Joinup https://joinup.ec.europa.eu/solution/dcat-application-profile-data-portals-europe

Repo for the German version: https://github.com/GovDataOfficial/DCAT-AP.de

ToDo: Crosscheck with metadata comparison table!

[Ludee]

A first draft of the new metadata version has been created.

[Ludee]

Discussion of the current status of the new metadata version in the wiki page metadata

[Ludee]

PROJECT: OPEN SOURCE ENERGIEWENDE Recommended metadata for a dataset:

Name	A name or a short description of this dataset.
ID	A globally unique identifier, e.g. Universal Unique Identifiers (UUID) and Digital Object Identifiers (DOI).
Homepage	A URL for the home on the web that is related to this dataset (“landing page”). The URL should be permanent.
Licenses	The license(s) under which the dataset is provided as name, URL and SPDX identifier, such as: Creative Commons Zero, https://creativecommons.org/publicdomain/zero/1.0/ , CC0-1.0).
Description	A description of the dataset. Depending on type and size this can be anything from one paragraph to several pages.
Documentation	A link to the further documentation of the dataset
Geographic scope	Specify the geographical area this dataset represents, e.g. “50hertz control zone”
Temporal scope	Specify the beginning and end of the total period covered by this dataset, e.g. “2008-01-01T00:00:00 to 2018-05-04T:23:59:59”
Unit	The unit of measurement, e.g. “MW”.
Publication date	The publishing date of the data package, such as 2018-04-05.
Sources	The raw sources for this dataset. Where the publishinger of this dataset is not the original creator of the data, proper reference should be given to the original source. For example, in the case of the ENTSO-E Transparency Platform, the contact details of the Primary Data Owner(s) as well as the Data Provider(s) should be provided.
Contact	A point of contact, such as a forum, or ideally a person available to contact for questions and feedback regarding the data.
Technical specifications	Information required to parse the data file(s) in the processing software, i.e. for CSV files the character encoding (i.e. “UTF8”), the columns separator (i.e. “,”) and decimal character (i.e. “.”). For time series data the format of datetime values (i.e.”YYYY-MM-DDThh:mm:ssZ”)
Time-resolution	For time series data, indicate the duration between time steps as well as whether data is associated with the beginning or end of a reported period.

Metadata for each variable (e.g., one column in a table of time series data or one attribute in a list of powerplants) Name | This property should correspond to the name of the column in the data file. As such it should be unique. Description | A description for this column. Unit | The unit of measurement, e.g. MW. Type | Indicate data type (e.g. ”string”, ”number”, ”datetime”) and format of this column, e.g. for a datetime ”YYYY-MM-DDThh:mm:ssZ” Geographical scope | For time series data, specify the geographical area this column represents, e.g. “50Hertz control area”. Temporal scope | For time series data, specify the beginning and end of the total period covered by this column, e.g. 2008-01-01T00:00:00 to 2018-05-04T:23:59:59..

[jh-RLI]

maybe add extra column to resources for the "schema"

[klarareder]

From the online survey we got the following feedback regarding metadata, I included only those data which I could not find in https://github.com/OpenEnergyPlatform/organisation/wiki/metadata:

project description description of model type description of further assumptions date of last update date of scenario generation where has the scenario been applied to possible restictions institute from which the scenario originates type of scenario (extreme, target…) reason for selectio of input data other reference year of cost data (Kostendaten) heating value vs. fuel value (Heizwert vs. Brennwert)

---

I am not sure with the following, if it is already decided how to handle them

origin of the data model input data model parameters model results

[Ludee]

Thanks for the comments @klarareder. I'm not sure if this can be added to the OEDB metadata strings. This should be added to feedback of the "model factsheets" and "scenario factsheets" on the OEP. https://github.com/OpenEnergyPlatform/oeplatform/issues

[jh-RLI]

not sure if the metadata string v. 1.4 already includes the "OEP Data Review" Badge system. If not add a "badge" field to contributors

[klarareder]

In the energy scenario conference one keynote mentioned that 'boundary conditions' are very important. I think we sould include that into our metadata set.

[Ludee]

v1.4 was missing the foreignKeys. I forgot to reference this issue in the hotfix: 8a68e4d5a48f2cefefdde9e1640aafdbb8c72fa2

[Ludee]

In addition to "context", we need to add two fields for the founding agency and a link to the logo:

Suggestion:

fundingAuthority fundingAuthorityLogo

Example:

"fundingAuthority": "Gefördert durch das Bundesministerium für Wirtschaft und Energie (BMWi)." or "fundingAuthority": "Bundesministerium für Wirtschaft und Energie (BMWi)." "fundingAuthorityLogo": "https://reiner-lemoine-institut.de/wp-content/uploads/2016/10/BMWi.jpg"

In addition, the OEP should display the image if it is a valid link:

[christian-rli]

I like your suggestions @Ludee

fundingAuthority fundingAuthorityLogo

, but I would prefer fundingAgency and fundingAgencyLogo, respectively - it just sounds less authoritatian :)

[Ludee]

Good point.

"fundingAgency": "Bundesministerium für Wirtschaft und Energie (BMWi)." "fundingAgencyLogo": "https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=poster&v=2"

And I found an official source of the image:

[klarareder]

I also prefer fundingAgency

[christian-rli]

closed with #58