BuEM

Contents:

  • Introduction
  • Installation Guide
  • Module Reference
    • Buildings Module
    • thermal — 5R1C Thermal Model
    • config — Building Configuration
    • weather — Weather Data Processing
    • occupancy — Occupancy & Electricity Profiles
    • apis — REST API Server
    • integration — GeoJSON Processing
    • technology — Building Technology Models
    • results — Plotting & Diagnostics
  • API Integration
  • Deployment
BuEM
  • Module Reference
  • View page source

Module Reference

Each sub-package of buem is documented in its own section below. For every module the page gives a brief purpose statement, describes the key classes/functions, and explains design decisions that are relevant for users and developers.

  • Buildings Module
    • Sub-packages
    • Assumptions
  • thermal — 5R1C Thermal Model
    • Purpose
    • 5R1C Network
    • Solver
    • Key Methods
    • Design Note — LP vs. Parameterisation
  • config — Building Configuration
    • Purpose
    • Key Components
    • Attribute Precedence
    • Components Structure
  • weather — Weather Data Processing
    • Module Overview
    • Processing Pipeline
    • Grid and Projections
    • Container Deployment
    • CLI Reference
    • CSV Weather Data
    • Version History
  • occupancy — Occupancy & Electricity Profiles
    • Purpose
    • OccupancyProfile
    • ElectricityConsumptionProfile
    • Integration
  • apis — REST API Server
    • Purpose
    • Endpoints
    • Files
  • integration — GeoJSON Processing
    • Purpose
    • GeoJsonProcessor
    • attribute_builder.py
    • send_geojson.py
    • Schema CLI
  • technology — Building Technology Models
    • Purpose
    • Existing Technologies
    • New Technologies
  • results — Plotting & Diagnostics
    • Purpose
    • PlotVariables
Previous Next

© Copyright 2026, Somadutta Sahoo.

Built with Sphinx using a theme provided by Read the Docs.