26 lines
1.4 KiB
Markdown
26 lines
1.4 KiB
Markdown
GridVerse MVP Scaffold
|
|
|
|
Overview
|
|
- Lightweight, extensible core for cross-domain optimization with a canonical registry and adapter marketplace skeleton.
|
|
- Core primitives are represented as in-memory contracts (LocalProblem as Objects, SharedVariables as Morphisms, Adapters as Functors).
|
|
- Provides a minimal ADMM-like solver and delta-sync stub for offline/partitions handling.
|
|
|
|
Tech Stack (initial)
|
|
- Python 3.x, numpy for numeric helpers, pytest for tests.
|
|
- In-repo registry and adapters with TLS transport stubs (not implemented in this minimal scaffold).
|
|
|
|
How to use
|
|
- Run tests with: bash test.sh
|
|
- EnergiaBridge Skeleton: Added gridverse/bridge_energia.py and a README note describing canonical interoperability bridging.
|
|
- Next MVP steps (Phase 0): finalize core protocol and 0.2 contract schemas, implement two starter adapters (e.g., DER controller, building load controller), and wire a minimal ADMM-lite solver with delta-sync scaffolding. Ownership: to be assigned.
|
|
- Extend with real adapters and a full TLS transport layer in subsequent iterations.
|
|
|
|
Testing Rules
|
|
- Tests run via pytest. Packaging checks run via python -m build.
|
|
- Keep changes small and backwards-compatible by default.
|
|
|
|
Contribution Guide
|
|
- Use the gridverse package namespace (gridverse.*).
|
|
- Add new adapters under gridverse/adapter_marketplace/ with a consistent interface.
|
|
- Update tests to cover new contracts and adapters.
|