sportgems 0.3.0

Find valuable gems 💎 in your tracked sport 🚴 activity!

sportgems

Sportgems finds valuable gems 💎 in your tracked sport 🚴 activity!

What is it?

Sportgems lets you efficiently parse your activity data. It will search and find your fastest sections. It will determine the start, end and speed of whatever fastest sections you are interested in, e.g. 1km, 2km, 10km and others. This repo is a rust reincarnation of the C++ implementation of the sportgems algorithm.

Sportgems is used in workoutizer to find your fastest 1km (and other 💎) in all your activities and ultimately visualize it.

Get Started

Sportgems is bundled in a python package using pyo3. Simply install it using pip:

pip install sportgems

In order to search for gems 💎 in your activity, pass the coordinates as list of tuples of floats (lat, lon) and the timestamps as a list of floats as seconds since the Unix epoch:

from sportgems import find_fastest_section

fastest_1km = 1000      # meter
coordinates = [(48.123, 9.35), (48.123, 9.36), (48.123, 9.37), (48.123, 9.38)]
times = [1608228953.8, 1608228954.8, 1608228955.8, 1608228956.8]

result = find_fastest_section(fastest_1km, times, coordinates)

The result will be a python object with the following attributes:

result.valid_section = True
result.start_index = 1
result.end_index = 2
result.velocity = 743.0908195788583

How does it work?

The following diagram illustrates how the core algorithm (implemented in gem_finder.cpp) works:

Running the tests

In order to run the rust unit tests simply run

cargo test --no-default-features

To run the python tests, you first need to install the requirements

pip install -r requirements.txt

and subsequently run the tests

pytest tests/

Contributing

Contributions are welcome!