openenergysphere-federated-.../README.md

1.5 KiB

OpenEnergySphere EnergiBridge (EnergiBridge MVP)

This repository implements a production-ready skeleton for OpenEnergySphere's federated, contract-driven cross-domain energy planning platform. The MVP focuses on the EnergiBridge interoperability layer, mapping OpenEnergySphere primitives to a canonical IR and enabling plug-and-play adapters across DERs, meters, pumps, and buildings while preserving offline-first operation and governance.

Note: Added a minimal EnergiBridge mapper (EnergiBridgeMapper) to illustrate canonical mappings between LocalProblem objects and a vendor-agnostic IR. This enables straightforward extension to more complex cross-domain workflows and adapters.

Architecture highlights

  • Core primitives: LocalProblem, SharedVariables, DualVariables, PlanDelta, PrivacyBudget, AuditLog
  • Graph-of-Contracts registry for adapters and data schemas with per-message metadata
  • Adapters: starter implementations (substation_meter, der_aggregator)
  • EnergiBridge: mapping functions between OpenEnergySphere primitives and a CatOpt-like IR
  • Server: FastAPI app exposing endpoints to register contracts and adapters
  • Storage: in-memory by default, with potential for SQLite/PostgreSQL persistence

Getting started

  • Install dependencies and run tests via test.sh
  • Run API locally: uvicorn energysphere.server.main:app --reload

This README intentionally provides a compact architectural overview and a concrete MVP workflow to accelerate collaboration and iteration.