37 lines
2.2 KiB
Markdown
37 lines
2.2 KiB
Markdown
# GridVerse MVP - Architectural Guidelines
|
||
|
||
- Language: Python 3.x
|
||
- Testing: pytest
|
||
- Packaging: python -m build (PEP 517/518)
|
||
- Quick run: `bash test.sh`
|
||
|
||
Architecture overview:
|
||
- gridverse.contracts: data classes for LocalProblem, SharedVariables, PlanDelta, ConstraintSet, DeviceInfo
|
||
- gridverse.registry: GraphContractRegistry - versioned, schema-validated registry
|
||
- gridverse.adapter_marketplace: starter adapters and a skeleton interface
|
||
- gridverse.solver: tiny ADMM-lite solver used for MVP planning
|
||
- gridverse.delta_sync: deterministic delta-sync stub for offline/partitioned operation
|
||
|
||
- Testing and CI hints:
|
||
- Tests cover contracts, simple solver, and delta-sync replay behavior
|
||
- Run: `bash test.sh` to verify pytest tests and packaging
|
||
- test.sh runs pytest and builds the package to ensure packaging integrity
|
||
|
||
## EnergiBridge Interoperability (Skeleton)
|
||
|
||
- Added gridverse/energi_bridge.py to provide a canonical bridge between GridVerse primitives and a vendor-agnostic intermediate representation (IR).
|
||
- This skeleton demonstrates verbs for translating contracts to IR, and a small mapper to illustrate adapter wiring without hard coupling to solvers.
|
||
- Use this as a reference when implementing cross-domain adapters and the Adapter Marketplace in Phase 0.
|
||
|
||
- Next steps (alignment with MVP plan):
|
||
- Integrate EnergiBridge mappings into the GraphContractRegistry conformance flows.
|
||
- Add lightweight tests for to_ir / from_ir translations.
|
||
- Expand the registry to support per-message metadata for auditability and replay protection.
|
||
- MVP Plan Alignment (8–12 weeks)
|
||
- Phase 0: Protocol skeleton and two starter adapters; minimal ADMM-lite solver; delta-sync seed.
|
||
- Phase 1: Governance ledger scaffold; conformance harness; offline simulations with digital twins.
|
||
- Phase 2: Marketplace scaffolding; minimal codegen path; UI wireframes for graph composition.
|
||
- Phase 3: Hardware-in-the-loop validation across 2–3 devices; KPI dashboards; cross-domain demo.
|
||
- Roles: core protocol work (you), EnergiBridge wiring (me), adapters/marketplace scaffolding (collaborative), governance/audit (joint).
|
||
- Deliverables should be packaged as a publishable MVP with tests passing locally, then signal readiness via READY_TO_PUBLISH.
|