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.6.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.6-cp313-cp313-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.13Windows x86-64

buildingmodel-1.0.6-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.6-cp312-cp312-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.12Windows x86-64

buildingmodel-1.0.6-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.6-cp311-cp311-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.11Windows x86-64

buildingmodel-1.0.6-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.6-cp310-cp310-win_amd64.whl (6.3 MB view details)

Uploaded CPython 3.10Windows x86-64

buildingmodel-1.0.6-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.6.tar.gz.

File metadata

  • Download URL: buildingmodel-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 a135aa9c7bd9ea934b46a3e4b5b04b5cbc203ec6b30869c2bc31e4ed89482286
MD5 ed47b43ee2264a2dc41858222bad39ea
BLAKE2b-256 97e4aeedc04103e3aec8d997b60a3e4f46d2ad4f516bb06a1bb5a720199cdb58

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.6-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 3ee3605f4cf487054fdc99767547d22d306d1543e2f4c274b74f3a8270ce83ee
MD5 a2de7a27ceeec60c4423813238ede383
BLAKE2b-256 c66e365d4b589fa8a4acbe833c78e7e580cb672e6b3ef0c2d79b62e31ce8bee1

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.6-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.6-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a3a0be2ee7d95f4445c87b0cd497799387e650f70f3ce5f6b964c6d1e87300c8
MD5 7032b96eb607b1505c2035c237d058dd
BLAKE2b-256 3df55d77a6609fe1391fa831673e921289ce623bb80fc0022f682b930f54935e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.6-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 a2c63b1df7a382c31f5735bf2c007c65ede21410671e6c031a0c143f39f6f31f
MD5 6ac6ad055ce4d7d2dc9e598826f37f9e
BLAKE2b-256 fd64aa8a447bc36b0c14c919d0a523a893e2d1df10670a2a3a3f72032a04267a

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.6-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.6-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7f3d0b892c3926c3a28bb12169acb44d0e81a3c158543f73d243fde3975b4887
MD5 952f6c604652432191383b995adf19e6
BLAKE2b-256 b8438887e5d42318181ec146f2840115bc7a85d495dc167f0ba34c01ee19a4ab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.6-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 9e70a45397899cbd8411888ace2cb78cd2b6b8c9d429f8d3f2646de85eaf798e
MD5 d5c31de180de2e023ccace12d74354d7
BLAKE2b-256 604e2a4197f7ff02522338a1eb9c013a06c790a3632b5851520ff3460d2ff408

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.6-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.6-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1aee24b588920a8d59cfbde2b05bedc4ac6ec1560fa3239e806e4b1707dcfe1c
MD5 d958c193305445768586504737e092a6
BLAKE2b-256 4724065a857634907253063d651e537dfc19f2320d611c08ca44325fa7cf2057

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.6-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 e9349afc5241cc32555a664b561d4c5d45d917ed376549bc935ea936303f80eb
MD5 ef560b66f1046b9dc2f3b534343587b8
BLAKE2b-256 1158782cfccc4669669c18e99b166d8355cca4375fd04daf7cb7afa15d670060

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.6-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.6-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c17be065abf045bde8a7c501318331eebcb25cbde027535abb1f9331f86733b0
MD5 ec846811cd40896685bb3a337c78f140
BLAKE2b-256 5a883da84301d869862e74c960cf295a978a76660f41f2f3acccb804a17c54da

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

This release

1.0.6 This release

9 files

1.0.5

9 files

1.0.4

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