Skip to main content

Processing Tool for Heat Demand Data

Project description

PyHeatDemand - Processing Tool for Heat Demand Data

PyPI - Version Conda GitHub License Read the Docs GitHub Workflow Status (with event) status Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Fig1

Overview

Knowledge about the heat demand (MWh/area/year) of a respective building, district, city, state, country or even on a continental scale is crucial for an adequate heat demand planning or planning for providing power plant capacities.

PyHeatDemand is a Python library for processing spatial data containing local, regional or even national heat demand data. The heat demand data can be provided as Raster, gridded polygon Shapefile, building footprint polygons Shapefile, street network linestring Shapefile, point Shapefiles representing the heat demand of a single building or an administrative area, and lastly postal addresses provided as CSV files.

The package is a continuation of the results of Herbst et al., (2021) within the Interreg NWE project DGE Rollout, NWE 892. E. Herbst and E. Khashfe compiled the original heat demand map as part of their respective master thesis project at RWTH Aachen University. The final heat demand map is also accessible within the DGE Rollout Webviewer.

Documentation

A documentation page illustrating the functionality of PyHeatDemand is available at https://pyhd.readthedocs.io/en/latest/.

It also features installation instructions (also see below), tutorials on how to calculate heat demands, and the API Reference.

Installation

PyHeatDemand is supported for Python version 3.10 and younger. Previous versions are officially not supported. It is recommended to create a new virtual environment using the Anaconda Distribution before using PyHeatDemand. The main dependencies of PyHeatDemand are GeoPandas and Rasterio for the vector data and raster data processing, Matplotlib for plotting, GeoPy for extracting coordinates from addresses, OSMnx for getting OpenStreet Maps building footprints from coordinates, Rasterstats for analyzing the resulting heat demand maps and more secondary dependencies like Pandas, NumPy, Shapely, etc.

Installation via PyPi

PyHeatDemand can be installed via PyPi using:

pip install pyheatdemand

Installation via Anaconda

PyHeatDemand is also available from conda-forge:

conda install -c conda-forge pyheatdemand

Installation using YML-file

It is recommended to use the provided environment.yml to ensure that all dependencies are installed correctly:

conda env create -f environment.yml

Make sure that you have downloaded the environment file in that case.

Forking or cloning the repository

The PyHeatDemand repository can be forked or cloned from https://github.com/AlexanderJuestel/pyheatdemand:

git clone https://github.com/AlexanderJuestel/pyheatdemand.git

A list of requirements.txt and an environment.yml provide a list of all necessary dependencies to run PyHeatDemand from source.

General Workflow

The general workflow involves creating a global mask of quadratic polygons (e.g. 10 km x 10 km) covering the entire studied area. This is especially used for larger areas such as states, countries or the Interreg NWE region to subdivide the area into smaller areas. Depending on the size of the input heat demand data, the corresponding underlying global mask polygons are selected and the final (e.g. 100 m x 100 m) resolution polygon grid is created. This grid including the input heat demand data is need to calculate the final heat demand map. Fig1

The actual heat demand data is divided into four categories or data categories:

  • Data Category 1: Heat demand raster data or gridded polygon (vector) data, different scales possible
  • Data Category 2: Heat demand data as vector data; building footprints as polygons, street network as linestrings, single houses as points
  • Data Category 3: Heat demand as points representative for an administrative area
  • Data Category 4: Other forms of Heat Demand data such as addresses with associated heat demand or heat demand provided as usage of other fuels, e.g. gas demand, biomass demand etc.

Processing steps for Data Types 1 + 2 Fig1

Processing steps for Data Types 3 Fig1

Contribution Guidelines

Contributing to PyHeatDemand is as easy as opening issues, reporting bugs, suggesting new features or opening Pull Requests to propose changes.

For more information on how to contribute, have a look at the Contribution Guidelines.

Continuous Integration

A CI is present to test the current code. It can be initiated using pytest --cov within the test folder. After running the tests, coverage report -m can be executed to get an report on the coverage and which lines are not covered by the tests.

API Reference

For creating the API reference, navigate to the docs folder and execute sphinx-apidoc -o source/ ../pyheatdemand.

References

Jüstel, A., Humm, E., Herbst, E., Strozyk, F., Kukla, P., Bracke, R., 2024. Unveiling the Spatial Distribution of Heat Demand in North-West-Europe Compiled with National Heat Consumption Data. Energies, 17 (2), 481, https://doi.org/10.3390/en17020481.

Herbst, E., Khashfe, E., Jüstel, A., Strozyk, F. & Kukla, P., 2021. A Heat Demand Map of North-West Europe – its impact on supply areas and identification of potential production areas for deep geothermal energy. GeoKarlsruhe 2021, http://dx.doi.org/10.48380/dggv-j2wj-nk88.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyHeatDemand-0.1.3.tar.gz (90.6 MB view details)

Uploaded Source

Built Distribution

PyHeatDemand-0.1.3-py3-none-any.whl (40.7 kB view details)

Uploaded Python 3

File details

Details for the file PyHeatDemand-0.1.3.tar.gz.

File metadata

  • Download URL: PyHeatDemand-0.1.3.tar.gz
  • Upload date:
  • Size: 90.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for PyHeatDemand-0.1.3.tar.gz
Algorithm Hash digest
SHA256 889728df445e10216ce6e058f42e10d8dd0a7130b8d839d1700968f47f0c00c8
MD5 78a971fceefb9aaccd2b502ef83ac9fe
BLAKE2b-256 e27b2013b93fae33b5915dac841928443224acdc8812512e9452054b974bf950

See more details on using hashes here.

File details

Details for the file PyHeatDemand-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for PyHeatDemand-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9d94ba75349e1e1a580a413f128c9c72fd6d0dcdec0331bb2e92720d590bb300
MD5 17bfbf3be984d324db3046ca18f895e8
BLAKE2b-256 77ed2e4af193d0e7307fa70e7be355bff984dd5ac554347dd2268d9244631aca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page