Skip to main content

BuildingModel

Description: BuildingModel is a district-level building energy simulation tool designed to leverage the availability of large scale open datasets on building geometry, census-derived dwelling characteristics and energy performance diagnosis. The methodology proposed combines GIS data processing with statistical inference techniques to obtain a description of each building's envelop geometry (including adjacency), thermal performances (envelop and systems) and occupation. This description is then used as the input of a physical model calculating solar gains, losses through boundaries and ventilation, heating system consumption and occupant-related energy usage.

  • Technology stack: Python 3, GeoPandas
  • Status: Beta (0.2). The complete toolchain is functional, but validation and fine-tuning of the models are still ongoing.

Screenshot: Example of results that can be obtained from a BuildingModel run with the GeoPandas integration allowing easy interactive plotting in Jupyter Notebooks

Documentation: The complete documentation for buildingmodel (methodology and API) is available at DOCS

Limitations

BuildingModel has been developed and tested only in the French context, for which GIS, census and energy diagnosis data is available. However, the generic character of the methodology should make it suitable for other countries as long as similar datasets can be obtained. In addition, BuildingModel currently deals only with residential buildings, due to limitations on the availability of data for other building usages.

Dependencies

BuildingModel depends mainly on Python 3 (currently tested on Python 3.8) and GeoPandas. A detailed set of dependencies is available in requirements.txt

Installation

Detailed installation instructions available at INSTALL.

Usage

In its most basic form, BuildingModel can be used by invoking the high level run_all function and passing it the path to the building GIS file :

from buildingmodel.main import run_all, Parameters
from buildingmodel import data_path
from pathlib import Path

parameters = Parameters()
buildings, boundaries, climate, dwellings = run_all(Path(data_path['gis']) / 'testing' / 'test_sample.gpkg',
                                            None, parameters)

The results returned ar GeoDataFrame in the case of buildings and boundaries and DataFrame in the case of the climate and dwellings. More advanced uses and result processing are available as jupyter notebook examples in the documentation.

How to test the software

From the root folder of BuildingModel, run :

pytest

Known issues

  • Current occupant-related energy usage models are very crude and subject significant future changes.
  • Energy consumption of heating systems relies on a constant efficiency model that will be replaced by technology-specific models (in particular for heat pumps).
  • Peak consumption estimates are provided by building but cannot be summed directly to obtain the total peak consumption of the district as the peaks may not be all synchronous.
  • Consumption of cooling systems is not modelled

Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

Getting involved

BuildingModel is looking for users to provide feedback and bug reports on the initial set of functionalities as well as developers to contribute to the next versions, with a focus on validation of models, cooling need simulation, adaptation to other countries' datasets and building usages.

Instructions on how to contribute are available at CONTRIBUTING.

Open source licensing info

  1. LICENSE

Credits and references

BuildingModel physical models are directly derived from the work of Antoine Rogeau in Vers une approche intégrée d’aide à la planification énergétique territoriale : application à la rénovation énergétique des bâtiments

Funding :

Main contributors :

Download files

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

Source Distribution

buildingmodel-1.0.4.tar.gz (6.1 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

buildingmodel-1.0.4-cp313-cp313-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.13Windows x86-64

buildingmodel-1.0.4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (6.8 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

buildingmodel-1.0.4-cp312-cp312-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.12Windows x86-64

buildingmodel-1.0.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (6.8 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

buildingmodel-1.0.4-cp311-cp311-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.11Windows x86-64

buildingmodel-1.0.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (6.8 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

buildingmodel-1.0.4-cp310-cp310-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.10Windows x86-64

buildingmodel-1.0.4-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (6.8 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

File details

Details for the file buildingmodel-1.0.4.tar.gz.

File metadata

  • Download URL: buildingmodel-1.0.4.tar.gz
  • Upload date:
  • Size: 6.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for buildingmodel-1.0.4.tar.gz
Algorithm Hash digest
SHA256 730c1240b994029d228491c2ba35ca46bbc7aa2b45bacc90ea6272b4fdb03401
MD5 9ea44d4f8e1d31bfb72d47c2828588c2
BLAKE2b-256 b318af33ce58e7833d186c4b28ba271133b950726abe7992f47acd9d1c761ac3

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 b7442ae9f2f4738af8d396a3730b11ad7ddfaa73e6021608cf8f50c9cfbea680
MD5 41b4fc6e9644faaaedf56a0f960befc3
BLAKE2b-256 9fab6cbe8cad50c16ac73561649cdfe1aba898f804391b3866477d1c224f0095

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 de492e54e4d196c70d13b0e07b61f496226ed80faff22edf826c2606dace9e68
MD5 5f144ffb93d9be5ed4136f93850c8c68
BLAKE2b-256 3e5996e02547816e85b3fbc2e7b428803485e1e975ea57b2e1e09ed4d827d56f

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 7b7c09066603ec08cd9a857ebec453ffbd9f633ac48f4f2981111a5bff3e0c66
MD5 7031142cb7403d7c2e24a128382731a6
BLAKE2b-256 c96748cf4e67fc0c2d0b6fe75d955b38d0b14e022dcdc9a6de663d413d77812e

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4dfeaed37d5092182db6226d61f380a7206389c42397ce0a0284a28dc9e9c78a
MD5 fd09b5fb176bcd3ac86615ec087c6af9
BLAKE2b-256 5459f0ccd8487936d6a90a2d481f5c5fb6d3c80fbbe3255667b7c80dfd2c03de

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 0fd0773ae7798b7a1f2c03975280464019e2cff383370b1542ec288d5ffe3a64
MD5 e4a76cb632b8e810ffd1436305147bae
BLAKE2b-256 ffc7ae3b9eae0fa616b8e2921d8a6f74eabd76d798e46bac5befa55bfa9861f5

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d3670fba187ad550712cdab2d2b4164ae197199725ea8045937bd1a2635c1bfa
MD5 c8ddac713e9bce5f104e66b9bd75a4ad
BLAKE2b-256 b6d93429aa01d82f2531d1fa6cc9099953d1285e76bedda6aafbec98b74b3094

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 97c4e401894c62d1c7eae775485e17c5c49fe905919e9115099df3afcb13c08a
MD5 64d5fbf7f988d5c78efc099b521027f4
BLAKE2b-256 fdfb9bb323756a999094e245aa6f06527271a218d19200dbec03781da8011fc3

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.4-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for buildingmodel-1.0.4-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 14f0f041e8520400d51bba952ca004540994d55c2c315d3fef3e40270fffbc69
MD5 8ec5fadd38ea0eb54aa3e7067f75ec63
BLAKE2b-256 eaad1da2f635f96e27c83d407f7703c4a57f0fbff2db3fa8456286624701fc40

See more details on using hashes here.

Release history Release notifications | RSS feed

1.10.0

9 files

1.9.0

9 files

1.8.0

9 files

1.7.0

9 files

1.6.0

9 files

1.5.0

9 files

1.4.0

9 files

1.3.0

9 files

1.2.0

9 files

1.1.0

9 files

1.0.7

9 files

1.0.6

9 files

1.0.5

9 files

This release

1.0.4 This release

9 files

1.0.3

5 files

1.0.2

5 files

1.0.1

5 files

1.0.0

5 files

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