This repository contains the documentation for the Building Energy Model (BuEM) package, specifically designed for developers integrating BuEM with other models via APIs through Docker containers.
BuEM is a comprehensive thermal simulation tool for building energy analysis. It provides:
- Thermal load calculations for heating and cooling
- REST API for model integration
- Docker containerization support
- Comprehensive building attribute system
The documentation is organized into the following sections:
- Introduction: Overview of BuEM and its capabilities
- API Integration: Detailed guide for developers on API usage
- Model Attributes: Complete reference of building attributes and data exchange formats
- Technical Reference: In-depth technical documentation
- Installation: Setup and deployment instructions
- Examples: Practical examples and use cases
This documentation is hosted at: https://buem.readthedocs.io/
To generate the documentation locally:
Make sure you have the BuEM conda environment activated:
conda activate buem_envInstall documentation dependencies:
pip install -r docs/requirements.txtcd docs
make htmlThen the HTML is generated in the directory docs/build/html.
Open the index.html in that directory in your browser to see your changes.
# Clean previous build
make clean
# Build HTML documentation
make html
# Build PDF documentation (if LaTeX is installed)
make latexpdfWhen contributing to the documentation:
- Use reStructuredText (.rst) format
- Follow the existing structure and style
- Test builds locally before submitting
- Focus on developer-oriented content for API integration
When changes are pushed to the main branch, the online documentation is automatically regenerated within a few minutes through ReadTheDocs integration.
This documentation is part of the BuEM project and follows the same license terms.