search

FZJ-IEK3-VSA / hplib

Database with efficiency parameters from public Heatpump Keymark datasets as well as parameter-sets and functions in order to simulate heat pumps (manufacturer+model or generic type)
MIT License
70 stars 15 forks source link

Open data license and FAIR metadata for hplib_database.csv #11

Open Ludee opened 3 years ago

Ludee commented 3 years ago

Hi @ttjaden, great work to free the hp data and make it available for all kinds of modelling. As an expert on open data licenses I would like to help to improve on the data publication. At the moment, the resulting data is part of the repository and thus licensed under the MIT license. While this is an excellent choice for the open-source software, it is not suitable for the resulting (open) data.

If you want to go deep into the open data licenses I can recommend this tutorial:

As a tldr, I would recommend two license options:

  1. CC-BY-4.0 a well known and standard open data license. Users only need to attribute correctly.
  2. ODbL-1.0 an OSM-like copyleft license. When people use and extend the data, they need to share the improvements. Downside: it can prevent people from using it.

My personal view would be option 1 for this data set, because the list has been generated by a script, not a manual collection and extraction of the pdf data (correct me if I am wrong).

In addition I suggest to create a standardised metadata string that contains all necessary information in machine and human readable formats. The OEMetadata was developed for this purpose:

I would be happy to assist you in creating the string, review and publish it.

ttjaden commented 3 years ago

First question @Ludee

Within the readme.md we describe, that the hplib_database.csvhas a CC-BY-4.0 license

grafik

Regarding the metadata string: This will be a good enhancement, thanks for the hint!