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

Uploaded CPython 3.13Windows x86-64

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

Uploaded CPython 3.12Windows x86-64

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

Uploaded CPython 3.11Windows x86-64

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

Uploaded CPython 3.10Windows x86-64

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

File metadata

  • Download URL: buildingmodel-1.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 c632d96c8bd53c0c0593b2bac442a29f9a5e75071b39c4a3e03b9e4dc426fc4b
MD5 1c662b4d25afe02a25f21793fd7f9088
BLAKE2b-256 c952a371626c94dc1e7a7abca12e58d6227fd68925102aae5a5208826187e4fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.7-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 7de7f31451cf32e849887ea407bd13507a449461d7550a8d2c1cbca9661694ec
MD5 f68d46317fcb4bc2b3b5124c8a672fec
BLAKE2b-256 31bb0edb6a71e1e6bb87e20b42f443a9f9ee735ac63181d75e36b4b348113a64

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.7-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.7-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8d6473ed59e5341601f9e86f69fa266734b39be652c7a4d9d2963d412e4db77f
MD5 631bcc4d3c98e220ee8ce6d077bd69d1
BLAKE2b-256 096b700c6784875b4cb14d7b212ffd24e413bfde677fdbe620f51fe97bf845e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.7-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 33d555be7eb9cf2844599f2f2963e97f260c89172d3f0fdb44ffad24b5ff6cd1
MD5 81c74f9888628cb60072a2caf4ec7b55
BLAKE2b-256 3be0ece33c1cd6e2b0c2d39bb6ecee57152067dc35dfe14624f35c5f3031fd88

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.7-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.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 dccd62e2a1f736f3e0bd53b0e4217b7caac90610f78e9e594bb3f449a290544b
MD5 b5d3ecce2c2da16c3ddda1d14f243b4d
BLAKE2b-256 c4b424d9808f159e308137d27afad9fd9cb8061aeb11f13c99cda482a1f4a8dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.7-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 0a1641c47dad8ef5fb855c078550a49524c3eba2eb73a161da3743600bdce256
MD5 4817d9eb4c423e4199c9e3b20bd7f63a
BLAKE2b-256 53242fdefdaaa76762839467f3ab1cc94a42fd5c03c909429ffcfa70bd010f82

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.7-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.7-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 607da66f56f545e102fb66d4f7b43c5f6d5209d69901d4ad89e9bc82bdd4e10d
MD5 0e650407ac83d9bcfd32e05832b01438
BLAKE2b-256 1e689b0df5430b7c92f136cce42a5978f5ecff3273658bc194743edf6e37dda2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for buildingmodel-1.0.7-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 fc30b94542a88e14d0163472be254b528369636a8c34337ce33f440614d95379
MD5 e062fcb737913056b1a747f154bb5a68
BLAKE2b-256 be07495bd16756e4923bacc4dc9e9ab4bffca7e734c21716a0f2cde364c2cff0

See more details on using hashes here.

File details

Details for the file buildingmodel-1.0.7-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.7-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 7a97fbc8ecae61821610f6d17c673c6233892fd75a0fda53451c642674b81170
MD5 a79155080199b4debe26984b9287a0e9
BLAKE2b-256 d3274fe7d4c5a71fb27ecfe28a6c1b349dfc9ea820414efdec1c7107be0c2795

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

This release

1.0.7 This release

9 files

1.0.6

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