idea46-solarpulse-viz-real/AGENTS.md

Architecture and Contributor Guide

Overview

• This repository hosts a production-ready MVP for SolarPulse Viz Real, an open-source framework for real-time visualization and anomaly insights across distributed solar, wind, and storage assets.

Tech Stack

• Backend: Python 3.9+ with FastAPI for REST APIs
• ML: Scikit-learn (IsolationForest) for unsupervised anomaly detection
• Data: SQLite (via SQLAlchemy) for lightweight persistence in the MVP
• Adapters: Lightweight Python modules for telemetry gateway and inverter fault detector
• Packaging: PyProject.toml with setuptools-based build

Key Modules

• src/idea46_solarpulse_viz_real/main.py: FastAPI app with endpoints for health and telemetry intake
• src/idea46_solarpulse_viz_real/anomaly.py: IsolationForest-based detector (embedded in app for MVP)
• adapters/telemetry_gateway.py: Starter adapter to parse telemetry payloads
• adapters/inverter_fault_detector.py: Starter adapter for fault detection logic
• tests/: Basic test suite to verify API and anomaly scoring

Testing & Running

• test.sh: Script to run tests and build (see file for details)
• Tests use pytest; you can extend tests to cover more endpoints and adapters

Publishing

• When you’re ready to publish, ensure READY_TO_PUBLISH exists at repo root and that tests pass locally.

Notes

• This MVP emphasizes minimal, correct changes with clean interfaces. Iterate with the swarm by adding more adapters, data contracts, and dashboards in subsequent sprint turns.