Create README.md

README.md

@@ -1,3 +1,29 @@
----
-license: cc
----
+# HEAPO – An Open Dataset for Heat Pump Optimization with Smart Electricity Meter Data and On-Site Inspection Protocols
+
+### Abstract
+
+Heat pumps are essential for decarbonizing residential heating but consume substantial electrical energy, impacting operational costs and grid demand. Many systems run inefficiently due to planning flaws, operational faults, or misconfigurations. While optimizing performance requires skilled professionals, labor shortages hinder large-scale interventions. However, digital tools and improved data availability create new service opportunities for energy efficiency, predictive maintenance, and demand-side management. To support research and practical solutions, we present an open-source dataset of electricity consumption from 1,408 households with heat pumps and smart electricity meters in the canton of Zurich, Switzerland, recorded at 15-minute and daily resolutions between 2018-11-03 and 2024-03-21. The dataset includes household metadata, weather data from 8 stations, and ground truth data from 410 field visit protocols collected by energy consultants during system optimizations. Additionally, the dataset includes a Python-based data loader to facilitate seamless data processing and exploration.
+
+### Data Description Paper
+
+For a detailed explanation of the dataset structure, file contents, and parameters, please refer to the dataset description paper: https://arxiv.org/abs/2503.16993
+However, please note that this manuscript on arXiv is a preprint and is currently under peer review. The dataset and dataloader are available in their initial version, but future updates may occur. If you use the dataset in its current form, please cite our arXiv paper:
+```
+@misc{brudermueller2025heapoopendataset,
+title={HEAPO -- An Open Dataset for Heat Pump Optimization with Smart Electricity Meter Data and On-Site Inspection Protocols}, 
+author={Tobias Brudermueller and Elgar Fleisch and Marina González Vayá and Thorsten Staake},
+year={2025},
+eprint={2503.16993},
+archivePrefix={arXiv},
+primaryClass={cs.CY},
+url={https://arxiv.org/abs/2503.16993}, 
+}
+```
+
+### Code Availability
+
+A Python-based dataloader and data usage instructions can be found on GitHub: https://github.com/tbrumue/heapo
+
+### Data Download
+
+The data is available for download on Zenodo: https://zenodo.org/records/15056919