gridresilience-studio-offli.../README.md

32 lines
2.7 KiB
Markdown

# GridResilience Studio (GRS) - Offline-First Cross-Domain Orchestrator
Overview
- A modular, open-source platform that coordinates distributed energy resources (DERs), water pumps, heating assets, and mobility loads to preserve critical services during outages and intermittent connectivity.
- Provides canonical primitives: Objects (LocalDevicePlans), Morphisms (SharedSignals), and PlanDelta (incremental islanding/load-shedding updates with cryptographic tags).
- Offline-first runtime with delta-sync to reconcile islanded microgrids with the main grid when connectivity returns.
- Adapters marketplace scaffolding for IEC 61850 devices, inverters, batteries, pumps, HVAC systems with TLS and mutual authentication.
- Governance ledger scaffold for audit trails and event-sourcing of resilience decisions.
Project Goals
- Build a production-ready core with well-defined primitives and an extensible adapters layer.
- Provide a small but usable MVP in Phase 0 that demonstrates end-to-end delta-sync and a simple joint objective for islanding and critical-load prioritization.
- Ensure packaging, testing, and publishing hooks are solid (test.sh, READY_TO_PUBLISH, AGENTS.md).
Usage
- Install: `pip install -e .`
- Run tests: `bash test.sh`
- See `src/gridresilience_studio/` for core implementations and `adapters/` for starter adapters.
- EnergiBridge & MVP Extensions
- This repository now includes a lightweight EnergiBridge canonical bridge to map GridResilience primitives to vendor-agnostic representations and starter adapters for IEC 61850 and a microgrid simulator. These scaffolds enable cross-domain interoperability while preserving offline-first operation.
- The EnergiBridge bridge lives at `src/gridresilience_studio/bridge.py` and adapters live under `src/gridresilience_studio/adapters/` as a Python package.
- Adapters scaffold contains: `IEC61850Adapter` and `MicrogridSimulatorAdapter` as starter implementations.
- The MVP wiring includes: 2 starter adapters, a minimal LocalDevicePlan/SharedSignal/PlanDelta sketch (via the DSL sketch in src/gridresilience_studio/dsl_sketch.py), and a toy delta-sync surface that can replay deterministically. See src/gridresilience_studio/energi_bridge.py, src/gridresilience_studio/dsl_sketch.py, and adapters/ for details.
- This remains a seed MVP; additional phases will introduce governance ledger, secure identities, and cross-domain dashboards in subsequent iterations.
- Usage
- Install: `pip install -e .`
- Run tests: `bash test.sh`
- See `src/gridresilience_studio/` for core implementations and `adapters/` for starter adapters.
- This repository is the MVP seed; follow-on agents will extend functionality, governance, and cross-domain testing.