Welcome to buildingmodel’s documentation

Buildingmodel is a multi building energy simulation tool that takes as input GIS data describing the building geometries and relevant properties (envelop thermal performance, energy systems, use profile) and returns the yearly energy consumption and peak power. To achieve this, it runs the following sequence of models: detection of adjacencies between buildings, calculation of boundary geometries, solar masks, climate data, solar gains, 3CL based thermal losses modelling and energy system efficiency.

• Installation
  • Pre-requisites
  • Installing from source
    • Obtaining the source code
    • Creating the conda environment
    • Installing buildingmodel
    • Running the test suite
    • Obtaining complete census and diagnosis data
    • Obtaining climate data
    • Compiling a local version of the documentation
  • Using docker image
• How To Use buildingmodel
• Examples
  • Boundary creation model
  • Parametric Study of the simplification tolerance
  • Multiple Inference
  • Solar gain model
  • Solar mask model
• Methodology description
  • Data Sources
    • GIS building data
    • Census data
    • Energy diagnosis data
    • Climate data
  • Loading and processing building-level GIS data
    • Geometrical Model
    • Coordinate reference system
    • Renaming
    • Filtering
    • Classifying buildings
    • Miscellaneous calculations
  • Boundary Creation
    • Geometry simplification
      • Algorithm
      • Parametric study of the tolerance parameter
    • Boundary geometry
      • Horizontal boundaries
      • Vertical boundaries
    • Additional attributes
  • Dwelling Creation
  • Dwelling Inference
    • Algorithm
    • Living area estimation (experimental)
      • Individual houses
      • Apartments
    • Building level records
    • Application
  • Building and Boundary Inference
    • Algorithm
    • Application
  • Climate Models
  • Solar Gains
    • Solar masks
    • Direct radiation
    • Transmitted radiation
    • Heating need contribution
  • Occupant Related Energy Needs
    • Domestic hot water needs
    • Specific electricity use
    • Cooking (experimental)
    • Attenuation with occupant count
    • Occupant gains
    • Impact of occupancy type
  • Thermal Losses
    • Boundary Losses
    • Ventilation losses
    • Thermal bridge losses (experimental)
    • Impact of occupancy type
    • Application
  • Thermal Needs
    • Heated area share
  • Energy Consumption
    • Heating
    • Domestic hot water
    • Specific use
  • Energy Indicators
    • Final energy consumption
    • Primary energy consumption
    • Energy diagnosis class
    • Application
• Use Cases
  • Introduction
    • Energy data sources
    • Data preparation
    • Simulation setup
  • Use Case Characteristics
    • Population density
    • Residential type
    • Construction periods
    • Occupancy
    • Heating systems
    • Energy consumption
  • Overall energy consumption
  • Variability at various scales
  • District Network Underestimation
  • Energy Consumption Overestimation
  • Building energy performance
    • Use case level
    • District level
  • Conclusion
• Main Module
• IO
  • GIS IO
    • clean_geometry()
    • load_data()
    • set_district()
    • set_residential_only()
    • set_residential_type()
  • Climate IO
    • load_data()
• Models
  • Weather Models
    • ground_temperature()
    • run_models()
    • sky_temperature()
    • sun_position()
  • Solar Mask Models
  • Solar gain models
  • Thermal losses Models
    • adjacency_factor()
    • boundary_losses()
    • maximal_temperature_difference()
    • run_models()
    • unified_degree_hours()
    • ventilation_losses()
  • Thermal needs Models
    • calculate_thermal_needs()
    • run_models()
  • Dwelling Need Models
    • actual_cooking_needs()
    • actual_dhw_needs()
    • actual_specific_needs()
    • conventional_needs()
    • daily_dhw_need()
    • occupant_count_factor()
    • run_models()
    • water_temperature()
  • Energy consumption Models
    • run_models()
• Module Reference
  • IO
    • GIS IO
      • clean_geometry()
      • load_data()
      • set_district()
      • set_residential_only()
      • set_residential_type()
    • Climate IO
      • load_data()
  • Models
    • Weather Models
      • ground_temperature()
      • run_models()
      • sky_temperature()
      • sun_position()
    • Solar Mask Models
    • Solar gain models
    • Thermal losses Models
      • adjacency_factor()
      • boundary_losses()
      • maximal_temperature_difference()
      • run_models()
      • unified_degree_hours()
      • ventilation_losses()
    • Thermal needs Models
      • calculate_thermal_needs()
      • run_models()
    • Dwelling Need Models
      • actual_cooking_needs()
      • actual_dhw_needs()
      • actual_specific_needs()
      • conventional_needs()
      • daily_dhw_need()
      • occupant_count_factor()
      • run_models()
      • water_temperature()
    • Energy consumption Models
      • run_models()
  • Main Module

Indices and tables

• Index

• Module Index

• Search Page