56 lines
3.6 KiB
Markdown
56 lines
3.6 KiB
Markdown
GridVerse Open Low-Code Platform
|
|
|
|
- Overview
|
|
- GridVerse is an open-source, cross-domain energy optimization platform. It provides:
|
|
- A Graph-Contract Registry for versioned data contracts
|
|
- An Adapter Marketplace for plug-and-play cross-domain adapters
|
|
- A tiny ADMM-like solver and delta-sync protocol for distributed optimization
|
|
- A canonical EnergiBridge to translate between GridVerse primitives and a vendor-agnostic IR
|
|
- Water-Pump adapter and cross-domain adapters (WaterPumpAdapter) to bootstrap multi-domain integration
|
|
|
|
Architecture (highlights)
|
|
- gridverse.contracts: LocalProblem, SharedVariables, PlanDelta, ConstraintSet, DeviceInfo
|
|
- gridverse.registry: GraphContractRegistry
|
|
- gridverse.adapter_marketplace: starter adapters and skeleton interface
|
|
- gridverse.solver / gridverse.delta_sync: lightweight solver and offline sync
|
|
- EnergiBridge: canonical bridge for cross-domain interoperability
|
|
|
|
How to run
|
|
- `bash test.sh` to run tests and packaging checks
|
|
- Python packaging is defined in pyproject.toml
|
|
|
|
This repository includes starter adapters to bootstrap interoperability:
|
|
- DERInverterAdapter and BuildingLoadAdapter under gridverse/adapter_marketplace
|
|
|
|
Ready to publish signal
|
|
- Once all MVP components are validated and tests pass, a READY_TO_PUBLISH file will be created at the repo root to signal readiness for publishing.
|
|
|
|
MVP Roadmap (high level)
|
|
- Phase 0 (0-2 weeks): define core protocol (Objects, Morphisms, Functors), publish contracts v0.2, implement two starter adapters, build a minimal ADMM-like solver and delta-sync engine.
|
|
- Phase 1 (2-4 weeks): add a small set of global constraints (mesh energy balance, water budgets), governance ledger, offline simulations with digital twins.
|
|
- Phase 2 (4-6 weeks): adapter marketplace entry points, minimal codegen path, reference UI for graph composition of devices and constraints.
|
|
- Phase 3 (6-8 weeks): hardware-in-the-loop validation with 2-3 devices, measure plan quality, convergence, latency; prepare for field pilots.
|
|
|
|
Contribution & Governance
|
|
- This project follows a collaborative, repository-driven development model. See AGENTS.md for architectural guidelines and contribution rules.
|
|
- Tests and packaging validation are required before considering publishing artifacts.
|
|
- If you add adapters, ensure they adhere to the Interface contracts and include minimal unit tests.
|
|
|
|
### EnergiBridge Interoperability (Optional Reference)
|
|
|
|
- EnergiBridge provides a canonical, lightweight bridge between GridVerse primitives and a vendor-agnostic intermediate representation (IR).
|
|
- It enables plug-and-play adapters and a Graph-of-Contracts registry to interoperate with external backbones (e.g., Open-EnergyMesh, CatOpt).
|
|
- Core mappings (illustrative):
|
|
- Objects -> LocalProblems (per-site optimization tasks)
|
|
- Morphisms -> SharedVariables / DualVariables (signals and priors)
|
|
- PlanDelta -> incremental decisions with metadata (timestamp, contract_id, signature)
|
|
- Limits/Colimits -> global constraints layer and policy hooks
|
|
- AuditLog / PrivacyBudget -> governance and audit trails per message
|
|
|
|
- MVP hook: EnergiBridge provides to_ir / from_ir translations and a minimal bootstrap_contracts helper to seed a registry with basic schemas.
|
|
- Starter adapters (DER, Building Load, etc.) wired through the Adapter Marketplace can consume/emit the canonical IR for cross-domain optimization.
|
|
- Next steps (phased):
|
|
1) Integrate EnergiBridge mappings into the GraphContractRegistry conformance flows.
|
|
2) Add lightweight tests for to_ir / from_ir translations.
|
|
3) Expand the registry to support per-message metadata for auditability and replay protection.
|