Skip to main content

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 (P_el) & thermal power (P_th) 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:

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 Reglulated On-Off
Outdoor Air / Water [1]: 366 [4]: 23
Brine / Water [2]: 54 [5]: 53
Water / Water [3]: 0 [6]: 10

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
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
Refrigerant Refrigerant Type R134a, R290, R32, R407c, R410a, other
Mass of Refrigerant [kg] Mass of Refrigerant 0.15 to 14.5 kg
SPL indoor [dBA] Sound emissions indoor 15 - 68 dBA
SPL outdoor [dBA] Sound emissions outdoor 33 - 78 dBA
PSB [W] Eletrical power consumption, standby mode 3 to 60 W
Climate Climate definition for set points, which were used for parameter identification average, colder, warmer
P_el_h_ref [W] Electrical power at -7°C / 52°C 881 to 23293 W
P_th_h_ref [W] Thermal heating power at -7°C / 52°C 2400 to 69880 W
p1-p4_P_th Fit-Parameters for thermal power -
p1-p4_P_el Fit-Parameters for electricl power P_el = P_el_ref * (p1 * T_in + p2 * T_out + p3 + p4 * T_amb)
p1-p4_COP Fit-Parameters for COP COP = p1 * T_in + p2 * T_out + p3 + p4 * T_amb
p1-p4_EER Fit-Parameters for EER EER = p1 * T_in + p2 * T_out + p3 + p4 * T_amb
MAPE_P_el mean absolute percentage error for electrical input power (simulation vs. measurement) average over all heat pump models = 16,3 %
MAPE_COP mean absolute percentage error for thermal input power (simulation vs. measurement) average over all heat pump models = 9,8 %
MAPE_P_th mean absolute percentage error for coefficient of performance (simulation vs. measurement) average over all heat pump models = 19,7 %

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.same_built_type(), 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 2021-03-12.

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.

Release files for hplib 1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hplib 1.9
File Size Uploaded
hplib-1.9.tar.gz 265.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hplib 1.9
File Interpreter ABI Platform
hplib-1.9-py3-none-any.whl Python 3 none any Details

Total release size: 511.7 kB

Release files / hplib-1.9.tar.gz

Download URL hplib-1.9.tar.gz
Size 265.8 kB
Tags Source
SHA-256 checksum
How to use checksums
81a0ba76c4c739ea9f5f7db7b7eb2dc72ab63df2731fc325d228357fbef63ae0
BLAKE2b-256 checksum
How to use checksums
3c0ea81d5bcfdceb22f0c1f636ec9567fad74769c073336071db85ea68fd9586
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release files / hplib-1.9-py3-none-any.whl

Download URL hplib-1.9-py3-none-any.whl
Size 245.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
958a4fd72b6a7d6bcba23177c829eecd3cb33686d3b51a7bc7a379432ca2b3f7
BLAKE2b-256 checksum
How to use checksums
8496e1bc1c0cadb2492d41be1840fcf57c2aa99a30da0e90a40a0891bec7b20d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release history Release notifications | RSS feed

This release

1.9 This release

2 release files

1.7

2 release files

1.6

2 release files

1.5

2 release files

1.2.1

1 release file

1.2.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page