Review: oemof_b3

[christian-rli]

Issue description

I'm submitting an open dataset with a corresponding OEMetadata string for review.

It's an upload of three models for the regions Berlin and Brandenburg using oemof. Metadata are generated with jupyter notebooks from the original files which came provided with a datapackage json that had to be adapted however.

Workflow checklist

1. GitHub

• I have submitted this issue to have metadata and data review documented (Issue #NR)
• Create a new review-branch and push OEMetadata to new branch (review/project_nameofdata#NR). If this step is too difficult, attach a file with the metadata as a comment in this issue and let the reviewer know.

2. OEP

• Upload data to the OEP in schema model_draft (see upload tutorial)
• Link URL of data in this issue (model_draft.project_nameofdata)

3. Start a Review

• Start a pull request (PR) from review-branch to master
• Assign a reviewer and get in contact

4. Reviewer section

• A reviewer starts working on the issue
• Review data license
• A reviewer finished working on this issue (and awarded a badge)
• Update metadata on table
• Data moved to its final schema
• Add OEP tags to table
• Merge PR and delete review-branch
• Document final links of metadata and data in issue description
• Close issue

Metadata and data for review

Here are the links to my data and metadata. Naming follows the pattern model_draft.project_nameofdata:
Metadata:
https://github.com/OpenEnergyPlatform/data-preprocessing/tree/review/project_oemof_b3_%2378/data-review/oemof_b3/simple_model
https://github.com/OpenEnergyPlatform/data-preprocessing/tree/review/project_oemof_b3_%2378/data-review/oemof_b3/simple_model_2
https://github.com/OpenEnergyPlatform/data-preprocessing/tree/review/project_oemof_b3_%2378/data-review/oemof_b3/simple_model_3
Data:
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_biomass_st

https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_biomass_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_bus
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_ch4_gt
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_curtailment
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_demand
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_demand_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_liion_battery
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_shortage
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_electricity_transmission
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_oil_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_other_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_solar_pv
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_solar_pv_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_wind_onshore
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_1_wind_onshore_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_biomass_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_bus
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_ch4_gt
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_curtailment
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_demand
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_demand_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_liion_battery
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_shortage
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_electricity_transmission
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_oil_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_other_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_solar_pv
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_solar_pv_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_wind_onshore
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_2_wind_onshore_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_biomass_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_bus
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_ch4_gt
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_curtailment
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_demand
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_demand_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_liion_battery
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_shortage
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_electricity_transmission
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_oil_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_other_st
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_solar_pv
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_solar_pv_profile
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_wind_onshore
https://openenergy-platform.org/dataedit/view/model_draft/oemof_b3_simple_scenario_3_wind_onshore_profile

Reviewed and published metadata and data

Final naming and location of the data and metadata after the review are as follows:
schema.tablename

• Metadata
• Data

[christian-rli]

As the tables have identical names for the different models and so do metadata files, I created subfolders in order to avoid naming conflicts. The ordering of files in the original data is the same for every model can can be observed in the screenshot:

[christian-rli]

I used jupyter notebooks for metadata creation and the uploads. There was one for each model, but they are essentially the same, only with names changed. A smarter use of functions could have avoided having three files. I am attaching the notebook for model_3.
oemof_b3_upload.ipynb.zip

[christian-rli]

These are the datapackages used to create the metadata
datapackages.zip

[jh-RLI]

The resources LGTM. But ...

There are several fields missing in the metadata. Please fill out the metadata (see complete oemetada example) string completely or provide at least information for the following fields here:

• description
• context
• sources
• licenses

Particularly important is an open license otherwise, the data can not be published on the OEP. For more information please have a look at the guide and/or contact us. I personally can recommend a CC BY 4.0 / CC BY-SA 4.0 license for open data.

[jh-RLI]

@christian-rli Who can I tag for further information?

[christian-rli]

@christian-rli Who can I tag for further information?

Good question @jh-RLI . The data come from RLI, so we are free to choose a license.
@Ludee am i right to think that our preferred license is CC-BY 4.0?
@jnnr since you are behind the data and plan on using it in your project(s), are there any limitations we have on our choice of license? Also, thank you for letting us know if more metadata become available.

[jh-RLI]

Then I create a metadata.json without resources. We can then fill in the missing fields and afterwards build a script to compose the full metadata string per model.

[Ludee]

I would indeed suggest CC-BY 4.0 as a license.