idea78-solarsphere-offline-.../README.md

31 lines
1.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SolarSphere Offline-First MVP
Overview
- A Python-based MVP for offline-first geospatial visualization and telemetry replay. Focuses on simple, well-defined data contracts and deterministic delta reconciliation that can run entirely offline with optional data-sync when connectivity returns.
Whats included
- Core data primitives: Asset, TelemetryPoint, WeatherLayer, Event
- CSV-based telemetry adapter for MVP data ingestion
- Delta reconciliation utilities for deterministic merges
- Lightweight render summary producing JSON suitable for downstream tooling
- Minimal CLI and a test suite to validate core behavior
Getting started
- Install dependencies and run tests: `bash test.sh`
- Package: `python3 -m build` (also in test script)
Project structure (high level)
- src/idea78_solarsphere_offline_first/: Python package with core models, adapters, delta logic, and rendering helpers
- tests/: Unit tests for models, delta logic, and adapters
- AGENTS.md: Architecture and contribution guidance
- test.sh: Test runner that executes tests and packaging checks
Usage example (quick)
- Load a CSV telemetry file via CSVAdapter, reconcile with a local delta, and render a snapshot:
- adapter = CSVAdapter("telemetry.csv")
- telem = adapter.load_telemetry()
- snapshot = render.render_snapshot([asset], telem, weather, events)
- print(snapshot)
This repository adheres to the contribution guidelines described in AGENTS.md and is designed to be extended in sprint fashion.