Developer Guide

Welcome to the HAEO developer documentation! This section covers architecture, development setup, and contribution guidelines.

Quick Start

git clone https://github.com/ha-energy-optimiser/haeo.git
cd haeo
uv sync
uv run pytest

Topics

• Architecture - System design overview
• Setup - Development environment with uv
• Units & Stability - Unit system and numerical considerations
• Energy Models - Creating new element types
• Coordinator - Data update coordinator pattern
• Testing - Running and writing tests
• Contributing - Contribution workflow