Turn a local Garmin Account Export into deterministic, auditable datasets and reusable analysis context—without uploading the export.
Garmin Running Data Normalizer is a local-first Python package that normalizes Garmin Activities, Gear, Personal Records, FIT Sessions and Laps, daily Wellness/Metrics datasets, and their reviewed relationship boundaries. Run-All emits normalized data together with QA, audit, provenance, explicit warnings, and human- and machine-readable analysis context.
- You want to process a Garmin Account Export locally.
- You want a stable foundation for long-term retrospective analysis.
- You do not want missing values or relationships filled by guesswork.
- You can use a Python CLI.
- You want reproducible outputs that can be reviewed before analysis.
- 17 stable normalized datasets with documented grains and stable keys.
- QA, audit, and provenance evidence alongside the normalized data.
- Deterministic output for the same supported input and environment.
- Explicit relationship boundaries instead of inferred joins.
- A human- and machine-readable analysis handoff.
Select the image to inspect the full-size accessible SVG.
- Product Quick Start — run the tracked synthetic fixture without a Garmin account.
- Getting Started from Garmin Export — move from a private local Export to a completed Run-All handoff.
- AI Analysis Quick Start — begin bounded descriptive analysis from a reviewed output.
- v1.4 Export Evidence and Diagnostics — interpret a real Run-All result, inspect its diagnostic artifacts, and create a public-safe Support Bundle for Human review.
- 日本語の短い案内
Completed the Synthetic Quick Start? Share a public-safe Synthetic Validation Report so we can learn whether the first-user workflow works outside the maintainer environment. Do not include real Garmin data or personal health information.
The previews below were generated from the tracked Synthetic Run-All fixture and a tracked fictional analysis CSV. They contain no personal Garmin data.
Select either preview to inspect its full-size accessible SVG.
See the asset sources and reproduction notes.
Current stable release: v1.4.0 · Python 3.11+ · Apache License 2.0
v1.4.0 adds read-only Export diagnostics and a Human-reviewed public-safe
Support Bundle without changing normalized datasets, stable keys, Snapshot
semantics, or the 0 / 0 / 3 / 2 Product exit contract.
v1.4.0 is published as the annotated tag, the latest stable GitHub Release, and the latest Production PyPI distribution. v1.3.3 remains the historical Sleep contract restoration patch release.
- Install from PyPI
- Quick Start
- Getting Started with a Garmin Export
- AI Analysis Quick Start
- FAQ
- Supported Datasets
- Known Limitations
- v1.4.0 Release Notes
- Published stable Release v1.4.0
- Production PyPI v1.4.0
- Project story on Zenn: English / 日本語
A Garmin Account Export is useful but is not automatically analysis-ready. It can contain multiple dataset families, archive layers, JSON records, and FIT assets with different grains and relationship boundaries. Ad hoc preprocessing can change columns, identifiers, filters, joins, and assumptions from one analysis to the next.
Without a stable handoff, repeated AI-assisted analysis can begin with the same preparation work each time:
Read the Export again
→ inspect the structure again
→ rebuild preprocessing
→ redefine missing-value rules
→ reconsider joins
→ finally begin the analysis
Run-All creates a reviewable boundary between that local export and downstream analysis: deterministic normalization, fixed output, QA and provenance, explicit relationships, visible warnings, and a separate human-owned interpretation step. Unknown relationships and incomplete input are not guessed away; unresolved, excluded, and warning states remain visible as evidence.
Normalize locally
→ reuse the reviewed output
→ ask a specific descriptive question
→ keep facts, calculations, interpretation, and unknowns separate
The package does not send the export to a hosted processing service. Public reproduction uses only synthetic fixtures.
The stable v1.3.0 release expands Run-All from the seven existing normalized datasets to 17 stable normalized datasets. It adds Hill Score, Endurance Score, Race Prediction, Sleep, UDS, Acute Training Load, Training Readiness, VO2Max, HRV reference, and Training History outputs while preserving each dataset's reviewed grain and stable key.
- Snapshot Accumulation applies the matching daily-state, immutable-observation, or regenerate policy and retains missing-is-not-delete behavior.
- In Snapshot-based runs, accepted Endurance and UDS values that differ for one stable key are retained in audit evidence as observed variants. A canonical daily winner is not selected without source-backed authority; same-export malformed/divergent input remains fail-closed.
- Generated Output Experience documents all 17 datasets and keeps the six existing explicit relationships unchanged.
- Wellness/Metrics context remains separate from Activity facts. Same-day comparison is contextual, not a direct relationship or causal claim.
- Lactate Threshold stays candidate/audit-only, and Health Status stays deferred; neither is promoted to the stable dataset registry.
- The v1.2.1 CLI, existing dataset IDs and stable keys, exit codes, imports, privacy boundary, and explicit relationship contracts remain unchanged.
See Supported Datasets, Dataset Relationships, and Known Limitations.
The v1.3.0 contract documents 17 datasets, 212 fields, and 6 explicit relationships. Five Wellness and Performance datasets use source-backed observation grains so multiple source observations are not collapsed by an unsupported latest-wins rule. A bounded private aggregate check found 0 divergent Stable Grain keys across those five datasets; exact key composition, private records, identifiers, paths, and validation artifacts remain private. Source-backed grain is a Product contract, not a Garmin-official semantic guarantee.
The reviewed release source passed 199 pytest checks, 170 unittest checks, 44/44 deterministic cases, Ubuntu and Windows CI, and build, wheel, sdist, installed-package, and clean-install gates. These results apply to the reviewed release scope and CI configurations; they do not imply zero defects or universal platform compatibility. The six established relationships remain authoritative, while the new Wellness and Performance datasets are context-only and do not define direct Activity joins.
Read CS-009: From Daily-Grain Assumptions to Source-Backed Observation Contracts in Garmin Data.
Read CS-010: From Real-Data Edge Cases to Evidence-Preserving Snapshot Semantics.
For the v1.3 design walkthrough on Zenn: English / 日本語.
The project was created by a full-marathon runner who has achieved sub-3:15 and is now working toward sub-3. It grew from repeated use of Garmin data for long-term running review: the goal is not only to convert files, but to make the same reviewed data foundation reusable across later analysis.
This runner story is supporting context, not a substitute for the product contract, tests, limitations, or published evidence.
python -m pip install garmin-running-data-normalizer
garmin-running-data-normalizer --versionThe equivalent module command is
python -m garmin_running_data_normalizer --version. The published v1.4.0
package installs tzdata automatically on Windows so Python can resolve the
existing IANA Asia/Tokyo timezone contract. macOS and Linux continue to use
their system timezone data.
Maintainers can reproduce the packaging gate without uploading anything:
python -m pip install -e '.[test,release]'
python -m build
python -m twine check --strict dist/*No Garmin account or real export is required. Obtain the repository so the
tracked synthetic fixture is available, then install the checkout. For the
maintainer-owned physical Windows validation, a clean Production PyPI v1.2.1
install brought in tzdata automatically; no manual timezone-data install was
needed.
git clone https://github.com/tsubotti63/garmin-running-data-normalizer.git
cd garmin-running-data-normalizer
python3 -m venv .venv
.venv/bin/python -m pip install -e .
.venv/bin/python -m garmin_running_data_normalizer run-all \
--input examples/synthetic/garmin_export \
--output workspace/run-allUse a clean repository folder prepared and tag-verified outside Windows, then copy that folder to the Windows machine. This keeps source acquisition separate from the Windows package/runtime gate.
Set-Location C:\Garmin\garmin-running-data-normalizer
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -e .
.\.venv\Scripts\python.exe -m garmin_running_data_normalizer run-all --input .\examples\synthetic\garmin_export --output .\workspace\run-allpython must resolve to Python 3.11 or later. If you use the Windows Python
launcher to select among multiple installed versions, you can use
py -3.11 -m venv .venv instead.
The installed console script is equivalent when its environment is active.
The activation-independent python -m form above also avoids PowerShell
execution-policy differences.
Use a new output path that does not already exist for every run. Run-All never
uploads the export. Start with START_HERE.md in the generated output. The
tracked fixture contains Activities only, so this tested example returns
PASS_WITH_WARNINGS with exit code 0 and records the absent optional families.
For the bounded activities-only Golden Path and its byte-for-byte Golden Result, follow the complete Product Quick Start.
| Platform | Validation status | Current position |
|---|---|---|
| macOS | Maintainer validated | Primary development and validation environment |
| Windows | CI and one physical environment validated | windows-latest validates the package paths; one maintainer-owned physical Windows environment clean-installed Production PyPI v1.2.1, automatically installed tzdata, resolved Asia/Tokyo, and completed the tracked Synthetic Run-All |
| Linux | GitHub Actions validated | Full tests, validators, builds, and isolated installs run on ubuntu-latest; manual environment characterization is not claimed |
Windows is not excluded from the project. Current evidence remains bounded: one maintainer-owned physical Windows environment plus GitHub Actions does not establish compatibility with every Windows version or installation. Reports should include the OS, shell, Python version, package version, command, exit code, and public-safe error details. Never attach a real Garmin Export or full personal Run-All output.
The incident, fix, and bounded post-publication evidence are recorded in CS-008: Windows Timezone Hotfix from Field Report to Production Validation.
The compatible one-shot command processes one supplied Export and does not accumulate records across separate downloads. A later Garmin Export can omit files, periods, records, or fields seen previously; that absence is not proof of deletion. Keep every downloaded Export until it has been registered in a verified Snapshot Store.
The additive Snapshot workflow in v1.2.0 keeps immutable local observations, builds a cumulative approved input, and then reuses the existing Run-All parser and output contract:
garmin-running-data-normalizer snapshot init \
--store workspace/snapshot-store \
--account local-account-01
garmin-running-data-normalizer snapshot register \
--store workspace/snapshot-store \
--input /path/to/complete-garmin-export \
--label S1 \
--requested-at 2030-01-01T00:00:00+00:00 \
--downloaded-at 2030-01-01T01:00:00+00:00 \
--observed-at 2030-01-01T02:00:00+00:00 \
--confirm-complete
garmin-running-data-normalizer snapshot verify \
--store workspace/snapshot-store
garmin-running-data-normalizer snapshot run-all \
--store workspace/snapshot-store \
--output workspace/snapshot-run-allUse one opaque account token per person/account boundary. Snapshot Stores and
their Run-All outputs are private local data: place them outside synchronized
or shared folders where practical, restrict directory permissions (for example,
chmod 700 workspace/snapshot-store on a single-user Unix-like system), and
never commit them. Back up a store only after snapshot verify reports PASS;
verify it again after restoration. Snapshot and blob deletion, automatic
garbage collection, and automatic deletion inference are not provided.
Public-safe aggregate validation used four repeated Garmin Account Data Export snapshots from the same account. It confirmed deterministic cumulative rebuilds, missing-value state handling, FIT content deduplication without duplicate decode, and all 13 specified failure/recovery checks, with zero modification of the source Exports.
These were four repeated complete Exports from one account, not four independent datasets. Within the reviewed Snapshot set and merge policy, all 6/6 pairwise comparisons, 24/24 tested registration-order permutations, and 13/13 specified failure/recovery checks passed. Seven materially distinct missing/value states were preserved, and the reviewed validation reported source mutation 0. These are bounded validation results, not a statistical, universal order-independence, zero-defect, or external-adoption claim.
Read CS-007: Preserving Garmin History Across Incomplete Repeated Exports.
Snapshot Accumulation is one data-integrity capability within the broader analysis-ready foundation; it is not the entire product.
See the v1.2 migration guide for adoption, backup, rollback, and one-shot compatibility guidance.
Run-All includes the context needed to review and analyze the result without reverse-engineering the data model.
Human-readable
START_HERE.mdDATASET_INVENTORY.mdANALYSIS_HANDOFF.md
Machine-readable
ANALYSIS_CONTEXT.jsonSCHEMA_CATALOG.jsonartifact_inventory.jsonrun_manifest.jsonrun_summary.json
The handoff describes dataset roles, grain, stable keys, explicit relationships, warnings, missing-value semantics, privacy boundaries, and prohibited operations. “AI-ready” means that this context is supplied; it does not guarantee that an AI answer is correct.
Exit code 0 means PASS or PASS_WITH_WARNINGS; exit code 2 is a fatal
contract, input, QA, or publication error; exit code 3 means PARTIAL_SUCCESS
because detected FIT input has an auditable incomplete parse. Existing output
is never overwritten, and identical input produces byte-identical output.
Add --external-safe-pack to create a deterministic, reviewable ZIP containing
an allowlisted month-level Activities projection. Run-All creates the pack
locally and never uploads it.
| Dataset or output | Implemented scope | Formal CLI support |
|---|---|---|
| Activities | summarizedActivities.json normalization with activity grain, garmin_activity_key, provenance, QA, and manifest |
Yes |
| Gear and activity-gear links | gear.json normalizer |
Run-All |
| Personal records | personalRecord.json normalizer |
Run-All |
| FIT sessions and laps | CRC-validated multi-session parser with fit_session_key and fit_lap_key; record coordinates and raw telemetry are not emitted |
Run-All |
| Activity/FIT links | Auditable evidence-qualified links with exclusions and relationship QA | Run-All |
| Hill Score Daily | Public-safe calendar-day Hill Score state with fail-closed same-day conflict handling | Run-All in v1.3.0 |
| Endurance Score Daily | Public-safe calendar-day Endurance Score state; Snapshot variants remain audit-preserved when canonicalization is unresolved | Run-All in v1.3.0 |
| Lactate Threshold | Four-family candidate/audit collection; unit, timezone, stable-key, and promotion gates remain open | Candidate audit only; not a stable dataset |
| Race Prediction observations | Garmin-provided 5K/10K/Half/Marathon predictions keyed by date and source timestamp; no private device fields | Run-All in v1.3.0 |
| Sleep Daily | sleepData.json bounded daily normalization with explicit review states; no filling or inferred awake time |
Run-All in v1.3.0 |
| UDS Daily | Selected steps, calories, heart rate, Body Battery, total stress, and source-presence flags; Snapshot variants remain audit-preserved when canonicalization is unresolved | Run-All in v1.3.0 |
| Acute Training Load observations | Garmin-provided timestamped acute/chronic values and ratio without recomputation or daily row selection | Run-All in v1.3.0 |
| Training Readiness observations | Garmin-provided timestamped readiness score, level, recovery, and component context | Run-All in v1.3.0 |
| VO2Max observations | Two source series in one generation-aware observation schema without cross-series overwrite | Run-All in v1.3.0 |
| HRV Daily | FIT Message 370 / Field 1 bounded daily analysis_reference_only output |
Run-All in v1.3.0 |
| Training History observations | Limited date, source timestamp, status, and optional sport context | Run-All in v1.3.0 |
| Health Status | Exact-suffix healthStatusData.json long metrics and fixed daily schema with explicit dedupe/review evidence |
No; library level only |
| Analysis Pack | Deterministic allowlist-only ZIP; optional external-safe profile is limited to month-level activity volume/count and removes identifiers, provenance, exact timestamps, and unneeded health/performance detail | Run-All opt-in |
The dataset registry documents stable keys, record grain, merge policy, and provenance requirements. See Supported Datasets for the stable CLI/output boundary and library-level scope.
The added rows above are available in the stable v1.3.0 GitHub Release and Production PyPI distribution. See the Performance Metrics Contract and Wellness and Daily Metrics Contract.
Version 1.1.1 was validated locally on one real-user dataset spanning
approximately 11.1 years, with 3,468 Activities, 3,684 FIT Sessions,
and 37,432 FIT Laps. These figures describe that validation dataset; they are
not a guarantee for every Garmin export or proof of continuous coverage.
The validation run completed with PARTIAL_SUCCESS: 0 errors and
1 FIT_PARSE_INCOMPLETE warning. Twenty incomplete FIT assets
(19 session/lap allocation conflicts and 1 unsupported chained asset) were
retained as auditable partial evidence instead of being guessed. FIT-derived
analysis is therefore limited to the parsed subset.
Under the same input, Production package, and host, three repeated runs produced
the same digest and byte-identical 20/20 output files in every repeat. The
repeat condition was same-host with cache state warm_or_unknown; this is not a
cross-machine performance guarantee. Private rows, paths, identifiers,
filenames, hashes, and detailed output remain unpublished.
Read CS-001: From a Real Garmin Export to an Auditable AI-Ready Handoff.
Relationship Coverage reports the boundary that can be linked by explicit evidence; it is not a success score.
In the same one-user validation dataset, Run-All established 3,464 explicit Activity–FIT relationships: 3,464 of 3,468 Activities and 3,464 of 3,465 eligible FIT Sessions. Four Activities and one eligible FIT Session remained unresolved rather than being guessed; ambiguous matches were 0, duplicate matches were 0, and inference was not performed. Activity-side and FIT Session-side denominators remain separate.
Read CS-002: Relationship Coverage as an Evidence Boundary.
Review generated START_HERE.md first. In a trusted local environment, follow
DATASET_INVENTORY.md and ANALYSIS_HANDOFF.md, then start with
analysis/activities.csv and the
Analysis Handoff Specification.
The Run-All Output Contract, Dataset Catalog, and Dataset Relationship Catalog explain artifact authority, dataset roles, and the explicit v1.1 joins. The prompt template, public usage example, and use-case catalog separate facts, calculations, interpretation, and unknowns.
Three key-free synthetic examples are available:
- Monthly and Weekly Training Trends
- Pace and Heart Rate Relationship
- Training Consistency and Return Pattern
Calculated facts are reproducible; generative wording is not claimed to be
byte-identical. The current garmin_activity_key may incorporate a source
activity ID. Keep real CSV local, remove that key from any externally shared
derivative, and review exact date/time granularity before transfer.
Real Garmin exports and full Run-All outputs are personal local data. Full normalized JSON, manifests, and audit files can contain identifiers, exact timestamps, source-relative paths, hashes, memo text, or source filenames that include email-shaped personal identifiers. Do not commit or upload real rows, stable keys, raw IDs, memo text, coordinates, source filenames, private paths, or raw private hashes.
Public examples use synthetic data or reviewed aggregate evidence only. The optional external-safe pack removes identifiers, keys, paths, hashes, memo text, coordinates, exact dates/times, heart rate, power, cadence, training effect/load, and other unneeded health or performance detail; it still requires human review before transfer.
The project does not provide medical, diagnostic, coaching, readiness, or causal conclusions. A human remains responsible for privacy approval, context, value judgment, and final interpretation.
PYTHONPATH=src python3 -m unittest discover -s tests -v
python3 scripts/validate_bootstrap.py
python3 scripts/static_policy_scan.py
python3 scripts/validate_platform_alignment.py
python3 scripts/validate_public_history.py --ciThe public-history command assumes a normal public clone whose origin/HEAD
points to origin/main. Only synthetic fixtures may be committed. Real Garmin
exports and generated personal output belong in ignored local directories.
- The documented Golden Path produces byte-identical JSON for identical input.
- Input is read-only; output must be absent or empty and is never silently overwritten.
--inputmust be a directory; passing a ZIP file directly is unsupported. ZIP assets discovered inside that directory are validated for traversal, links, encryption, entry count, size, total size, and compression-ratio limits.- Stable keys, activity record grain, source-relative provenance, hashes, and deterministic QA are included in the reviewed output contract.
- Unsupported or unsafe Golden Path input fails closed with a non-zero exit status.
Run-All v1 requires Activities; all other dataset families are optional. The
daily Wellness/Metrics outputs described above are included in stable v1.3.0,
while Health Status remains deferred. Hosted processing,
Open-Meteo, Parquet, and automatic upload are not
included. One-shot processing does not combine separate Export
downloads; retain each Export until the additive Snapshot lifecycle has
registered and verified it. Missing from a later Export is not a deletion
instruction. The documented CLI and versioned Run-All output contract are the
stable 1.x interface; other Python modules may evolve compatibly as their
contracts mature. See
Known Limitations
for the
precise boundaries.
Hosted processing, Garmin account authentication, JMA or Instagram ingestion, wellness/coaching interpretation, personal analysis, and non-Garmin data platform generalization are outside the project scope.
See the
Product Change History
for factual product
changes. The root CHANGELOG.md is the Product-owned router to that history;
the AI Collaboration Platform maintains its own separate changelog.
docs/project_os/: unmodified AI Collaboration Platform v0.9 Standarddocs/project/: Project Customization and current phase controlsdocs/proofs/: Platform capability evidencedocs/reference/: reuse, privacy, licensing, release, and handoff referencestemplates/: unmodified Platform project/operation templatesruntime/: unmodified Platform runtime plus Target Runtime Addendumsrc/garmin_running_data_normalizer/: public product implementationtests/: synthetic, dependency-free unit testspackages/: tracked package policy; review packs are generated under ignored.review/
This project is licensed under the Apache License 2.0.