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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.10Windows x86-64

buildingmodel-1.0.5-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.5.tar.gz.

File metadata

  • Download URL: buildingmodel-1.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 d208e12d1e09d31ba734e1ed586f0a8c8e6945aacaa6858ed3259c830068e27e
MD5 4bf55c3674c4b6f687bc25d36d382e87
BLAKE2b-256 53b389b44cf456484ede2274a3a5650378423973efbdb7360ae4b1f372949873

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.5-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 0fcc2c91f92b8c9b890f76b788c9e35a667a89d18b8708307eb40cf2087dc970
MD5 37a4da709124a80020d215cd575a9179
BLAKE2b-256 8e70d94c1c99bec5ff7cd78909a2d9acec95ddf0131970340067b4b9bee0e850

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.5-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.5-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 fa5797824a4b263e266e2a5159a3dfd0c64ed71d4c0ea5cc96e35e8eccb8b1d1
MD5 78bfbdadb60c25bddb11d2254af25ed4
BLAKE2b-256 a4696f608cb0fed0f70687a43af41a32e9a36b415ab33afffabbb661fb1d17ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.5-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 80ab01b97eab5d4fcf79a35618972ad5d5cef279a957a6d6aebc6ecbd3f5606f
MD5 87228294685c89b37cb2fa4401467a8f
BLAKE2b-256 b52df1b0814d9e12651dd5138a567ec4e9829e6451143d6ca447e0eb3935b0a8

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.5-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.5-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 deb7f9e5e6196768a194650f7e820e42d9eaa7d35e06339cee1e09ffd2200ce4
MD5 c990be35009a466032b0af876c03da17
BLAKE2b-256 40a49faa8a28f528978e7eeae35b597e1f38d4c90d63be911c7084f9b249a6cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.5-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 21a43e42924289878fba851e18418929f6e0ef93e72d0597b2d8d90269d75a79
MD5 d68ecbe5dfa23443000371be1c3c5756
BLAKE2b-256 2b276205e037972e5febdec69ae85fe266d1898bfe68cdc645458ceb7c12479a

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.5-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.5-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ebba6de5db381cc6ac4ad3794afc205c659349d9a9c30fed16d0ba02660b533c
MD5 79dc5ba33ec21624ba71d3b2500d7a56
BLAKE2b-256 301de2f932677d7481261d0f2ee163ae516204760d3b373eb21885f64069b4cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.5-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 9915b301c03f359d4f1f100530c5f8df4bc0cb132a3013b2b3ad935a746e634e
MD5 d9016734d274016d58ca08e3823aaaa9
BLAKE2b-256 341ab269f77cec3e8b51b1d45bdfa74481587b99a368d66e760f0b521d1ca615

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.5-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.5-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 511b0bc13ad27b5247e1fcd6b5e8065e5c0046b31aa3632372c6c9953c6051b3
MD5 8157baab2188ebe4bbbf99609684b426
BLAKE2b-256 d17c9941f95ed956807b130db06e81e94c5369c649e12c5c62f5e789cc03e563

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

This release

1.0.5 This release

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