Skip to content
Training Diary
Branch: master
Clone or download
Latest commit 3edd2a7 Apr 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ch2 dataframe climbs Apr 25, 2019
data fitted power, but very slow Mar 8, 2019
dev fixes to loading Mar 30, 2019
docs version 0.19.3 Apr 21, 2019
notebooks
tests fixing up tests Apr 4, 2019
.gitignore adding internal fields to fit Jan 1, 2019
LICENSE Create LICENSE Jun 18, 2018
MANIFEST.in version 0.10.11 Jan 4, 2019
README.md improve readme Apr 21, 2019
RELEASES.md
setup.py
todo fit accumulation Jan 9, 2019

README.md

Choochoo (ch2)

An open, hackable and free training diary.

Please see the full documentation. This page contains only some images and a Technical Overview.

The following plots are generated automatically from the diary - clicking a "link" starts Jupyter and pushes the page to the browser. The pages can be edited and serve as an introduction to accessing the data manually.

Technical Overview

All data are stored in an SQLite database (SQLAlchemy ORM interface). The schema separates "statistics" (named time series data) from the source (which might be direct entry, read from a FIT file, or calculated from pre-existing values).

Data are processed via "pipelines". These are Python classes whose class names are also configured in the database. Existing pipelines calculate statistics from FIT file data, add elevation data from SRTM files, recognise segments from GPS endpoints, estimate power output, and generate summaries (eg monthly averages).

A Python interface allows data to be extracted as DataFrames for analysis in Jupyter workbooks (or dumping to stdout). So general Python data science tools (Pandas, Numpy, etc) can be used to analyze the data. Example workbooks are included in the source.

The data are stored in an "open" format, directly accessible by third party tools, and easily backed-up (eg by copying the database file). When the database format changes scripts are provided to migrate existing data (see package ch2.migraine). Data extracted from FIT files are not migrated - they must be re-imported.

Support libraries include FIT file parsing, spatial R-Trees, and reading elevation data from SRTM files.

The "diary" view, where the user enters data, is itself generated from the database. So the fields displayed (and the statistics collected) can be customized. This configuration can include "schedules" which control when information is displayed (eg: weekdays only; every other day; second Sunday in the month).

The combination of customizable diary fields and scheduling allows training plans to be entered and displayed.

Customization (fields, training plans, etc) must be done via Python or SQL. There is no graphical user interface for configuration. This presents a steep learning curve but is ultimately very flexible - "any" training plan can be accommodated. Python code for generating example plans is included (see package ch2.config.plan).

Currently the program is single-user (ie the data in the database are not grouped by user). Multiple users can co-exist using separate database files.

Choochoo collects and organizes time-series data using athlete-appropriate interfaces. It facilitates calculations of derived statistics and extraction of data for further analysis using Python's rich data science tools. Both data and code are open and extensible.

You can’t perform that action at this time.