diff --git a/README.md b/README.md index ec5c315d..08d312d4 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,9 @@ The following columns are available for every heat pump of this library | 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| +| MAPE_P_el | mean absolute percentage error for electrical input power (simulation vs. measurement) | average = 16,3 % | +| MAPE_COP | mean absolute percentage error for thermal input power (simulation vs. measurement) | average = 9,8 % | +| MAPE_P_th | mean absolute percentage error for coefficient of performance (simulation vs. measurement) | average = 19,7 % | ## Input-Data and further development 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. diff --git a/input/README.md b/input/README.md index 509d3d8a..ad177c86 100644 --- a/input/README.md +++ b/input/README.md @@ -1,4 +1,4 @@ ## Input-Data -The European Heat Pump Association (EHPA) hosts a webiste 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. +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. +This repository is based on all pdf files that were downloaded for every manufacturer on 2021-03-12. diff --git a/output/README.md b/output/README.md index c2426c48..70ebd6b2 100644 --- a/output/README.md +++ b/output/README.md @@ -1,4 +1,4 @@ # Output data -This is the place for the CSV databases which are created by the function within the hplib-database.py +This is the place for the CSV databases which are created by the function within the hplib_database.py -In the end, these files are only for documentation purpose of the whole hplib library. They represent a structured format for all data that is located in the hundreds of PDF based KEYMARK reports. +In the end, these files are only for documentation purpose of the whole hplib library. They represent a structured format for all data that is located in the hundreds of PDF based KEYMARK reports together with validation data from hplib. diff --git a/src/README.md b/src/README.md index b9791efc..10af083f 100644 --- a/src/README.md +++ b/src/README.md @@ -1,9 +1,34 @@ ## src This folder contains the main files for usage: - -- in documentation.ipynb there are explenations and examples where the data is from, -what happend to the data, how to use this library for simulating and validation of the fit method. -- for simulation you need to import the hplib_database.csv where all parameters are saved and -hplib.py where all code for simulation is stored -- hplib_database.py is used for preperation of the data \ No newline at end of file + +|File|Content| +|:---|:---| +|documentation.ipynb|Explanations how the database was created. Examples how to use hplib.py for simulation. Validation calculations and plots.| +|hplib_database.csv|Database with one row per heatpump, containing relevant data and simulation parameters| +|hplib.py|Functions for simulations purposes| + +Columns and Description from **hplib_database.csv** + +| 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, Reglulated| +| 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_ref [W]| Electrical power at -7°C / 52°C | 881 to 23293 W | +| P_th_ref [W]| Thermal 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| +| MAPE_P_el | mean absolute percentage error for electrical input power (simulation vs. measurement) | average = 16,3 % | +| MAPE_COP | mean absolute percentage error for thermal input power (simulation vs. measurement) | average = 9,8 % | +| MAPE_P_th | mean absolute percentage error for coefficient of performance (simulation vs. measurement) | average = 19,7 % | \ No newline at end of file