energiamesh-federated-contr.../README.md

20 lines
966 B
Markdown

# EnergiaMesh (Prototype MVP)
EnergiaMesh is a prototype for federated, contract-driven microgrid optimization with on-device forecasting. This MVP focuses on the core data primitives and two starter adapters to bootstrap the CatOpt bridge in a minimal, testable form.
What you can expect in this MVP:
- Core primitives: LocalProblem, SharedVariables, PlanDelta, DualVariables, AuditLog
- A simple Graph-of-Contracts registry for versioned adapters
- Two starter adapters: DER controller and Weather station
- A small DSL sketch placeholder for LocalProblem/SharedVariables/PlanDelta
- Basic tests and packaging scaffolding to enable pytest and python build
- Getting started
- Install dependencies and run tests:
- bash test.sh
- To explore the MVP, look under src/energiamesh/
Packaging and publishing
- This repository uses a Python packaging layout under src/ with pyproject.toml.
- See READY_TO_PUBLISH when you are ready to publish the MVP as a package.