Project ChargedUp¶
Internal project planning
This section documents the internal Project ChargedUp initiative. Phase 1 is complete and shipped in v3.4.0. Phase 2 is planned but not implemented — features described in the roadmap and Phase 2 documents do not exist in the current release. For current capabilities, see the User Guides and API Reference.
BatteryProc redesign initiative (codename: ChargedUp) — faster, more flexible ingestion; formula‑driven metrics; improved UX (CLI + future GUI); higher test coverage; cleaner architecture; packaging & distribution readiness.
This landing page orients contributors to the most current strategic material. Deep details live in EPIC issues and PRs — keep these pages concise and link out instead of duplicating.
Status Snapshot (Phase 1 Complete)¶
| Theme | Status | Notes |
|---|---|---|
| Ingestion & Formats | COMPLETE | Parser registry, 4 formats (XLSX/CSV/TXT/MPT), config mappings shipped v3.4.0 |
| Metrics Engine | COMPLETE | Formula-driven capacity/energy/CE, cycle synthesis, validation checks implemented |
| Performance | PHASE 2 | Baseline established; optimization (parallel, chunking) planned Phase 2 |
| UX (CLI/GUI) | CLI COMPLETE, GUI PHASE 2 | CLI refactored and stable; GUI prototype planned Phase 2 |
| Visualization | STABLE | Plot helpers in place; adaptive layouts planned Phase 2 |
| Quality & Tests | 84% COVERAGE | 711 tests passing; comprehensive suite |
| Architecture | COMPLETE | Parser/metrics/plotting modular; registry pattern implemented |
| Packaging | PHASE 2 | Local install stable; PyPI distribution planned Phase 2 |
| Data Persistence | EXPLORATORY | Deferred to Phase 2; unclear ROI for current workflow |
Last reviewed: 2025-11-07 (Phase 1 closeout).
Page Index¶
- Roadmap (
ChargedUp_Roadmap.md): Strategic narrative & milestone candidates - Cheat Sheet (
cheat_sheet.md): 1‑page quick reference - Phase 1 Summary (
phase1_summary.md): what shipped and why - Phase 2 Kickstart (
phase2_kickstart.md): how to restart work
How to Contribute¶
- Read the Cheat Sheet for orientation (labels, branching, DoD).
- Scan Status Snapshot & Roadmap to avoid duplicating work.
- Open or update an EPIC (template) for any net‑new strategic slice.
- Create granular tasks (template) referencing the EPIC; keep scope < ~2 days where possible.
- Link decisions back into Roadmap (Decision Log) if they emerged from discussion.
Conventions¶
- Source of truth: Roadmap (strategy & decision rationale), EPIC issues (scope), tasks (implementation), PRs (diff)
- Summaries first, details linked. Avoid stale duplication of requirements.
- Decision entries: date, concise decision, rationale, follow‑ups/owners.
Phase 1 Complete – Phase 2 Next Actions¶
Phase 1 is complete! See Phase 1 Summary for details.
Phase 2 preparation (when ready to start): - [ ] Review Phase 2 Kickstart Guide - [ ] Establish performance baseline (profiling + benchmark suite) - [ ] Create Phase 2 EPIC issues (GUI, performance, packaging) - [ ] Gather user feedback on Phase 1 features
Questions or proposing a significant deviation? Open a discussion or add a summary to the Roadmap then link supporting artifacts.