27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# SunHub Agent Overview
|
|
|
|
Architecture
|
|
- SunHub is a modular, city-scale solar siting and DER coordination platform.
|
|
- Core abstractions:
|
|
- Object: a neighborhood-level optimization target (Object in a city may map to a block or district).
|
|
- SharedSignal: aggregated signals used for cross-neighborhood coordination (e.g., forecasted irradiance, storage state).
|
|
- PlanDelta: incremental actions to advance planning (delta updates to per-neighborhood plans).
|
|
- GraphOfContracts: registry for adapters to external systems (GIS, weather, DER controllers).
|
|
- Lightweight federation: simplified ADMM-lite loop coordinating neighborhood plans while preserving locality.
|
|
|
|
Tech Stack (in this repo)
|
|
- Python 3.10+ with setuptools-based packaging (pyproject.toml).
|
|
- Tests powered by pytest.
|
|
- Lightweight in-memory data models for MVP; pluggable adapters via GraphOfContracts.
|
|
|
|
Testing and Commands
|
|
- Run tests: `bash test.sh` in repo root. This also builds the package (`python3 -m build`).
|
|
- Local development: import sunhub.core modules and run minimal scenarios via `pytest` tests.
|
|
|
|
Contribution Rules
|
|
- Use the AGENTS.md as a jump-off for new agents; implement features in small, well-scoped patches.
|
|
- All changes must pass tests before PRs; avoid breaking existing contracts in the in-repo API.
|
|
|
|
Notes
|
|
- This document will be updated as the project evolves and new agents are introduced.
|