Skip to main content

Python library for analysis of ANT/Garmin .fit files

Project description

heartandsole

Python library for analysis of running data files.

Python 3.6 License


Table of Contents


Introduction

heartandsole is designed to work with running or walking activity files. It reads data from .fit or .tcx files, cleanses the data, and performs calculations, such as the following:

  • running power (based on Dr. Philip Friere Skiba's GOVSS algorithm)
  • average running power
  • normalized running power (based on information publicly available about TrainingPeaks' NP® and NGP®, and Dr. Philip Friere Skiba's GOVSS algorithm)
  • intensity (based on information publicly available about TrainingPeaks' IF®)
  • training stress (based on information publicly available about TrainingPeaks' TSS® and Dr. Philip Friere Skiba's GOVSS algorithm)
  • average heart rate
  • elapsed time
  • moving time

My impetus for this project was to implement a version of Philip Friere Skiba's GOVSS algorithm (with tweaks to better align with the underlying research). The end result will be a free, open-source version of proprietary calculations found in platforms like Strava and Training Peaks. My hope is that other runners will benefit as I have from taking these secret algorithms out of their black box, by understanding the science behind these calculations and training smarter.

This package was originally forked from Michael Traver's fitanalysis package, but the two projects diverged significantly enough for me to move my fork to a separate repository. I am indebted to Michael for writing such a clean, useful, easy-to-understand package that served as heartandsole's starting point.


Dependencies and Installation

Pandas, lxml, NumPy, python-dateutil, fitparse, and spatialfriend are required.

pip install heartandsole to install.


Example

heartandsole provides the Activity class.

import heartandsole

fit = heartandsole.FitFileReader('my_activity.fit')
activity = heartandsole.Activity(fit.data)

print(activity.elapsed_time)
print(activity.moving_time)

# Also available for power, equivalent-power flat-ground speed,
# cadence, and heart rate:
print(activity.mean_speed)

# Calculates running power from speed, and elevation data.
power = activity.power

# 30-second moving average power is a more suitable
# proxy for metabolic intensity than instantaneous power.
power_smooth = activity.power_smooth

# Summarizing activity power with the 4-norm is more representative
# of intensity than average power.
print(activity.norm_power)

# Intensity and training stress calculations require a threshold 
# power value (in Watts/kg), which the utility functions can calculate
# from flat-ground threshold pace (min/mile).
pwr = heartandsole.powerutils.flat_run_power('6:30')
print(activity.power_intensity(pwr))
print(activity.power_training_stress(pwr))

# Intensity and training stress may also be calculated from
# HR data. This calculation requires a threshold HR value in BPM.
print(activity.hr_intensity(162))
print(activity.hr_training_stress(162))

Construction of a FitFileReader parses the .fit file and reads the data into a pandas DataFrame.

Construction of an Activity accepts a pandas DataFrame formatted by one of the FileReader classes, cleanses the data, then detects periods of inactivity.


Project Status

Complete

  • Add capability to read .tcx files.

Current Activities

  • Integrate .tcx file reading into the file analysis tool on my website.

  • Make a project wiki so I can be as verbose as I please.

  • Make life a little easier with Travis CI.

Future Work

  • Expand file-reading ability to .gpx, .pwx, and more.

  • Expand data cleansing methods in Activity.


References

Coggan, A. (2012, June 20). Re: Calculate Normalised Power for an Interval [Online forum comment]. Retrieved June 14, 2017, from http://www.timetriallingforum.co.uk/index.php?/topic/69738-calculate-normalised-power-for-an-interval/&do=findComment&comment=978386

Coggan, A. (2016, February 10). Normalized Power, Intensity Factor and Training Stress Score. TrainingPeaks. Retrieved June 14, 2017, from https://www.trainingpeaks.com/blog/normalized-power-intensity-factor-training-stress/

Coggan, A. (2003, March 13). TSS and IF - at last! [Online forum post]. Retrieved June 14, 2017, from http://lists.topica.com/lists/wattage/read/message.html?mid=907028398&sort=d&start=9353

Di Prampero, P. E., Atchou, G., Brückner, J. C., & Moia, C. (1986). The energetics of endurance running. European Journal of Applied Physiology and Occupational Physiology, 55(3), 259-266.

Di Prampero, P. E., Capelli, C., Pagliaro, P., Antonutto, G., Girardis, M., Zamparo, P., & Soule, R. G. (1993). Energetics of best performances in middle-distance running. Journal of Applied Physiology, 74(5), 2318-2324.

Eckner, A. (2017, April 3). Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators. Retrieved June 14, 2017, from http://eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf

Friel, J. (2009, September 21). Estimating Training Stress Score (TSS). TrainingPeaks. Retrieved June 22, 2017, from https://www.trainingpeaks.com/blog/estimating-training-stress-score-tss/

Minetti, A. E., Moia, C., Roi, G. S., Susta, D., & Ferretti, G. (2002). Energy cost of walking and running at extreme uphill and downhill slopes. Journal of Applied Physiology, 93(3), 1039-1046.

Pugh, L. G. E. (1971). The influence of wind resistance in running and walking and the mechanical efficiency of work against horizontal or vertical forces. The Journal of Physiology, 213(2), 255-276.

Skiba, P. F. (2006, September 16). Calculation of Power Output and Quantification of Training Stress in Distance Runners: The Development of the GOVSS Algorithm. RunScribe. Retrieved August 20, 2019, from http://runscribe.com/wp-content/uploads/power/GOVSS.pdf


Contact

Reach out to me at one of the following places!


License

License

This project is licensed under the MIT License. See LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for heartandsole, version 0.0.19
Filename, size File type Python version Upload date Hashes
Filename, size heartandsole-0.0.19-py3-none-any.whl (20.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size heartandsole-0.0.19.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page