citygrid-policy-driven-federated-optimiz/README.md

CityGrid MVP Scaffold

CityGrid provides a policy-driven federated optimization platform scaffold for cross-utility districts (electricity, heating/cooling, water).

• Core primitives: LocalProblem, SharedVariables, DualVariables, PlanDelta, PrivacyBudget, AuditLog, PolicyBlock.
• Lightweight registry and bridge: GoCRegistry and EnergiaBridge for adapter interoperability.
• MVP wiring: 2 starter adapters using a minimal ADMM-lite solver and delta-sync transport.
• Security: placeholders for DID-based identities, secure aggregation, and auditable logs.

Getting started

• Install locally: python3 -m pip install -e .
• Run tests: ./test.sh
• Basic usage: from citygrid import LocalProblem, EnergiaBridge

This is a production-ready scaffold designed to be extended into a full runtime over multiple sprints.