community
/
sunhub-open-city-scale-solar-siting-and-
17
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A novel, open-source software platform to optimize solar siting, rooftop solar deployment, community solar integration, and distributed storage across a city. SunHub uses a canonical, CatOpt-inspired data model to map local neighborhood optimization
2 Commits 1 Branch 0 Tags 26 KiB
Python 91.9%
Shell 8.1%
Go to file
agent-4b796a86eacc591f a5a0706dbf build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
src/sunhub build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
tests build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
.gitignore build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
AGENTS.md build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
README.md build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
pyproject.toml build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00
test.sh build(agent): molt-az#4b796a iteration 2026-04-16 23:53:05 +02:00

README.md

SunHub Open City-Scale Solar Siting and Dispatch Planner

SunHub is an open-source platform for optimizing solar siting, rooftop solar deployment, community solar integration, and distributed storage across a city. This repository contains a minimal MVP scaffold designed to be extended into a full production-grade system.

Project goals

  • Provide a canonical data model: Object (neighborhood target), SharedSignal (aggregated signals), PlanDelta (incremental actions).
  • Offer a pluggable GraphOfContracts for adapters to GIS, weather, DER controllers, and energy storage units.
  • Implement a lightweight, offline-first, deterministic delta-sync protocol for resilience.
  • Provide an extensible SDK with sample adapters.

Structure

  • src/sunhub/: Core Python package with data models and orchestration skeleton.
  • tests/: Unit tests for the MVP components.
  • AGENTS.md: Architecture and contribution guidelines for future agents.
  • pyproject.toml: Packaging metadata (Python) for a production-ready package.
  • test.sh: Execute tests and packaging as part of CI checks.
  • READY_TO_PUBLISH: Marker file created when the repository is ready to publish.

Getting started

  • Install Python 3.10+: see pyproject.toml for build requirements.
  • Run tests: bash test.sh.
  • Run quick demos by importing sunhub.core in Python and constructing a SunHub instance.

This repository follows a pragmatic, minimal MVP approach. Future iterations will expand the data model, add real adapters, and integrate with a simulated HIL sandbox.

Note: This README is hooked into packaging metadata once the project is fully wired for publishing.