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)

https://github.com/FZJ-IEK3-VSA/hplib

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

energy heatpump simulation
Last synced: 10 months ago · JSON representation

Repository

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)

Basic Info
  • Host: GitHub
  • Owner: FZJ-IEK3-VSA
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Homepage:
  • Size: 444 MB
Statistics
  • Stars: 77
  • Watchers: 5
  • Forks: 15
  • Open Issues: 14
  • Releases: 10
Topics
energy heatpump simulation
Created over 5 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

FZJ Logo

hplib - heat pump library

Repository with code to

  • build a database with relevant data from public Heatpump Keymark Datasets.
  • identify efficiency parameters from the database with a least-square regression model, comparable to Schwamberger [1].
  • simulate heat pump efficiency (COP) as well as electrical (Pel) & thermal power (Pth) and massflow (m_dot) as time series.

For the simulation, it is possible to calculate outputs of a specific manufacturer + model or alternatively for one of 6 different generic heat pump types.

[1] K. Schwamberger: „Modellbildung und Regelung von Gebäudeheizungsanlagen mit Wärmepumpen“, VDI Verlag, Düsseldorf, Fortschrittsberichte VDI Reihe 6 Nr. 263, 1991.

For reference purposes: - DOI: DOI - Citation: Tjarko Tjaden, Hauke Hoops, Kai Rösken. (2021). RE-Lab-Projects/hplib: heat pump library (v2.0). Zenodo. https://doi.org/10.5281/zenodo.5521597

Documentation

If you're interested in how the database and parameters were calclulated, have a look into the Documentation HTML or Jupyter-Notebook. There you also find a simulation examples and a validation.


Heat pump models and Group IDs

The hplib_database.csv contains the following number of heat pump models, sorted by Group ID

| [Group ID]: Count | Regulated | On-Off | | :--- | :--- | :--- | | Outdoor Air / Water | [1]: 5812 | [4]: 40 | | Brine / Water | [2]: 283 | [5]: 194 | | Water / Water | [3]: 6| [6]: 6 |

Database

All resulting database CSV file are under License: CC BY 4.0.

The following columns are available for every heat pump of this library

| Column | Description | Comment | | :--- | :--- | :--- | | Manufacturer | Name of the manufacturer | 30 manufacturers | | Model | Name of the heat pump model | 506 models | | Titel | Name of the heat pump submodel | use titel name for simulating | | Date | heat pump certification date | 2016-07-27 to 2021-03-10 | | Type | Type of heat pump model | Outdoor Air/Water, Brine/Water, Water/Water | | Subtype | Subtype of heat pump model | On-Off, Regulated| | Group ID | ID for combination of type and subtype | 1 - 6| | Rated Power low T [kW] | Rated Power for low temperature level | -7/34 °C | | Rated Power medium T [kW] | Rated Power for medium temperature level | -7/52 °C| | Refrigerant | Refrigerant Type | R134a, R290, R32, R407c, R410a, other | | Mass of Refrigerant [kg]| Mass of Refrigerant | 0.15 to 17.5 kg | | SPL indoor [dBA]| Sound emissions indoor| 15 - 68 dBA| | SPL outdoor [dBA]| Sound emissions outdoor| 33 - 78 dBA| | Bivalence temperature [°C] | Minimum temperature heat pump is running without supplementary heater| Tbiv not used in simulation| | Tolerance temperature [°C] | Minimum temperature heat pump is running with supplementary heater| *TOL not used in simulation| | Max. water heating temperature [°C] | Maximum heating temperature | *Tmax not used in simulation| | Poff [W] | Eletrical power consumption, ? | *Poff not used in simulation (0-110 W)| | PTOS [W] | Eletrical power consumption, ? | *Ptos not used in simulation (0-404 W)| | PSB [W] | Eletrical power consumption, standby mode | *Psb not used in simulation (0-110 W)| | PCKS [W] | Eletrical power consumption, ? | *Pcks not used in simulation (0-99 W)| | eta low T [%] | Efficiency for low temperature level| 105-300% | | eta medium T [%] | Efficiency for medium temperature level| 107-202% | | SCOP | seasonal COP | 2,7-7,7 | | SEER low T | seasonal EER for low Temperature Level | 3,39-12,93 | | SEER medium T | seasonal EER for medium Temperature Level | 5,04-13,87 | | Pthhref [W]| Thermal heating power at -7°C / 52°C | 2400 to 69880 W | | Pthcref [W]| Thermal cooling power at ? | 3000 to 53200 W | | Pelhref [W]| Electrical power at -7°C / 52°C | 881 to 29355 W | | Pelcref [W]| Electrical power at ? | 881 to 17647 W | | COPref | COP at -7°C / 52°C | 1,53 to 7,95 | | EERref | Electrical power at ? | 1,99 to 10,8 | | p1-p4Pth | Fit-Parameters for thermal power | - | | p1-p4Pel | Fit-Parameters for electricl power | Pel = Pel_ref * (p1Tin + p2*Tout + p3 + p4Tamb) | | p1-p4COP | Fit-Parameters for COP | COP = p1Tin + p2*Tout + p3 + p4*Tamb| | MAPEPth | mean absolute percentage error for coefficient of performance (simulation vs. measurement) | average = 19,7 % | | MAPEPel | mean absolute percentage error for electrical input power (simulation vs. measurement) | average = 16,3 % | | MAPECOP | mean absolute percentage error for thermal input power (simulation vs. measurement) | average = 9,8 % | | MAPEPdc | mean absolute percentage error for coefficient of performance (simulation vs. measurement) | average = 19,7 % | | MAPEPel | mean absolute percentage error for electrical input power (simulation vs. measurement) | average = 16,3 % | | MAPE_EER | mean absolute percentage error for electrical input power (simulation vs. measurement) | average = 16,3 % |

Usage

  • Get repository with pip:
    • pip install hplib

or:

  • Download or clone repository:
    • git clone https://github.com/RE-Lab-Projects/hplib.git
    • Create the environment:
    • conda env create --name hplib --file requirements.txt

Create some code with from hplib import hplib and use the included functions hplib.load_database(), hplib.get_parameters, hplib.HeatPump(), hplib.HeatPump.simulate(), hplib.HeatingSystem.calc_brine_temp() and hplib.HeatingSystem.calc_heating_dist_temp()

Hint: The csv files in the output folder are for documentation and validation purpose. The code and database files, which are meant to be used for simulations, are located in the hplib folder.


Input-Data

The European Heat Pump Association (EHPA) hosts a website with the results of laboratory measurements from the keymark certification process. For every heat pump model a pdf file can be downloaded from https://keymark.eu/en/products/heatpumps/certified-products.

This repository is based on all pdf files that were download for every manufacturer on 2023-04-17.

Further development & possibilities to collaborate

If you find errors or are interested in developing together on the heat pump library, please create an ISSUE and/or FORK this repository and create a PULL REQUEST.

License

MIT License

Copyright (c) 2023

You should have received a copy of the MIT License along with this program. If not, see https://opensource.org/licenses/MIT

About Us

Institut TSA

We are the Institute of Energy and Climate Research - Techno-economic Systems Analysis (IEK-3) belonging to the Forschungszentrum Jülich. Our interdisciplinary department's research is focusing on energy-related process and systems analyses. Data searches and system simulations are used to determine energy and mass balances, as well as to evaluate performance, emissions and costs of energy systems. The results are used for performing comparative assessment studies between the various systems. Our current priorities include the development of energy strategies, in accordance with the German Federal Government’s greenhouse gas reduction targets, by designing new infrastructures for sustainable and secure energy supply chains and by conducting cost analysis studies for integrating new technologies into future energy market frameworks.

Owner

  • Name: Forschungszentrum Jülich - Jülich Systems Analysis
  • Login: FZJ-IEK3-VSA
  • Kind: organization
  • Location: Forschungszentrum Jülich

Institute of Climate and Energy Systems (ICE)

GitHub Events

Total
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 3
Last Year
  • Issues event: 1
  • Watch event: 7
  • Issue comment event: 3

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 315
  • Total Committers: 5
  • Avg Commits per committer: 63.0
  • Development Distribution Score (DDS): 0.435
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
xihaui 7****i@u****m 178
Tjarko Tjaden t****n@g****m 96
Kai Rösken k****1@g****m 23
l-kotzur l****r@g****m 12
Kai Rösken 6****r@u****m 6

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 20
  • Total pull requests: 21
  • Average time to close issues: 5 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 13
  • Total pull request authors: 6
  • Average comments per issue: 1.2
  • Average comments per pull request: 0.29
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 17 hours
  • Issue authors: 5
  • Pull request authors: 1
  • Average comments per issue: 1.17
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ttjaden (6)
  • alex9green (2)
  • xihaui (2)
  • Ludee (1)
  • dfurrer (1)
  • heikotroetsch (1)
  • albesibbe (1)
  • NicolaBlasuttigh (1)
  • Mousa-Zerai (1)
  • thamer-eng (1)
  • Jalal-Khan0 (1)
Pull Request Authors
  • xihaui (11)
  • ttjaden (4)
  • l-kotzur (3)
  • fastrockstar (2)
  • OfficialCodexplosive (1)
  • rolanddi (1)
Top Labels
Issue Labels
enhancement (6) documentation (2) help wanted (1)
Pull Request Labels