What problem does it solve?
Create repeatable, traceable versioned checkpoints for research and EDA experiments so changes can be audited, compared, and rolled back with clarity and reproducibility.
Core Features & Use Cases
- Structured commits and tags: Guidance for consistent commit titles and optional annotated tags to mark stable checkpoints.
- Human-readable version log: Maintain per-topic version logs that capture version token, baseline, characteristics, distinguishing points, changed files, and validation evidence.
- Validation and traceability: Commands and checks to verify commit contents, changed-file lists, and diffs for reliable comparisons and recoveries.
- Use Case: Snapshot an experiment before a new parameter sweep, tag the snapshot, and update the version log to compare outcomes against a defined baseline.
Quick Start
Commit and tag the current experiment as a version token, then append the commit hash, baseline, characteristics, distinguishing points, and changed files to the appropriate docs/versioning/<topic>.version_log.md.