Skip to main content

GPS Tools - A collection of tools to work with GPS track files.

Project description

GPS Tools

CI Coverage Status PyPI - Version

Python 3.12+

GPS Tools - A collection of tools to work with GPS track files.

Example Usage

convert .fit file to .gpx file

gpst process track.fit -o track.gpx

Detailed Usage

$ gpst -h
usage: gpst [-h] [--version] tool ...

GPS Tools - A collection of tools to work with GPS track files.

positional arguments:
  tool        Available tools:
    map       Draw map of input file.
    plot      Plot data from the input file.
    process   Process GPS track file and write results to a GPX file.
    track     Generate a .track file from .fit, .gpx, or .vbo activity data.

options:
  -h, --help  show this help message and exit
  --version   show program's version number and exit

gpst process

$ gpst process -h
usage: gpst process [-h] -o OUT_FILE [-y] [--fix-elevation DEM_FILE [DEM_FILE ...]] [--dem-crs DEM_CRS] [--elevation-smoothing-window METERS] [--grade-calculation-window METERS] IN_FILE

positional arguments:
  IN_FILE               Path to input file (.gpx, .fit, .vbo).

options:
  -h, --help            show this help message and exit
  -o OUT_FILE, --output OUT_FILE
                        Path to the output file.
  -y, --yes             Accept questions (e.g. overwrite existing output file).
  --fix-elevation DEM_FILE [DEM_FILE ...]
                        Correct elevation data using DEM files.
  --dem-crs DEM_CRS     Coordinate reference system of the DEM files to be used if no CRS is specified in the files themselves (e.g. 'EPSG:4326').
  --elevation-smoothing-window METERS
                        Smoothing window for elevation data in meters (default: 100).
  --grade-calculation-window METERS
                        Window size for grade calculation in meters (default: 100).

Example DEM coordinate reference systems:

  • PL-KRON86-NH -> 'EPSG:2180'
  • PL-EVRF2007-NH -> 'EPSG:9651'

When --fix-elevation is in use, tool produces report in form of csv file and png plot, e.g.:

$ gpst process track.fit -o ./track.gpx -y --fix-elevation ./dem/*.asc --dem-crs EPSG:2180

Elevation Fix

Elevation Plot without and with --fix-elevation

No fix

Plot

With fix

Plot

gpst plot

Note: plot tool does not calculate additional fields, to use calculated fields with FIT file, convert with process tool to GPX first

$ gpst plot -h
usage: gpst plot [-h] -x X_AXIS -y Y_AXIS [Y_AXIS ...] [--y-right Y_AXIS_RIGHT [Y_AXIS_RIGHT ...]] [-t {line,scatter}] [--type-right {line,scatter}] [--width WIDTH] [--height HEIGHT] [-o OUTPUT] FILE

positional arguments:
  FILE                  Path to input file (.gpx, .fit, .vbo).

options:
  -h, --help            show this help message and exit
  -x X_AXIS, --x-axis X_AXIS
                        Field to use for the x-axis.
  -y Y_AXIS [Y_AXIS ...], --y-axis Y_AXIS [Y_AXIS ...]
                        Field to use for the y-axis.
  --y-right Y_AXIS_RIGHT [Y_AXIS_RIGHT ...]
                        Field to use for the y-axis on the right side.
  -t {line,scatter}, --type {line,scatter}
                        Plot type: line, scatter. Default is line.
  --type-right {line,scatter}
                        Plot type for right y-axis: line, scatter. Default is line.
  --width WIDTH         Width of the output image in pixels (default: 2048).
  --height HEIGHT       Height of the output image in pixels (default: 1024).
  -o OUTPUT, --output OUTPUT
                        Path to the output image file. If not provided, shows the plot interactively.

Example:

$ gpst plot ./track.gpx --x-axis distance --y-axis grade --y-right elevation smooth_elevation -o plot.png --width 1024 --height 512

Plot

gpst map

Note: map tool does not calculate additional fields, to use calculated fields with FIT file, convert with process tool to GPX first

$ gpst map -h
usage: gpst map [-h] [--dem DEM_FILE [DEM_FILE ...]] [--dem-crs DEM_CRS] [--width WIDTH] [--height HEIGHT] [--line-width LINE_WIDTH] [-o OUTPUT] [--show-title] [--trim {tight,box}] FILE

positional arguments:
  FILE                  Path to input file (.gpx, .fit, .vbo).

options:
  -h, --help            show this help message and exit
  --dem DEM_FILE [DEM_FILE ...]
                        DEM files to use as background elevation data.
  --dem-crs DEM_CRS     Coordinate reference system of the DEM files to be used if no CRS is specified in the files themselves (e.g. 'EPSG:4326').
  --width WIDTH         Width of the output image in pixels (default: 4096).
  --height HEIGHT       Height of the output image in pixels (default: 4096).
  --line-width LINE_WIDTH
                        Width of the track line (default: 2.5).
  -o OUTPUT, --output OUTPUT
                        Path to the output image file. If not provided, shows the map interactively.
  --show-title          Show the activity name as the title of the map.
  --trim {tight,box}    Trim the map to the track bounds.

Example:

$ gpst map ./track.gpx --dem ./dem/*.asc --dem-crs EPSG:2180 -o map.png --width 1024 --height 1024 --trim box --line-width 1

Map

gpst track

Generate a race .track definition by detecting full laps (finish-to-finish without pit entry/exit crossings) and building a median centerline.

$ gpst track -h
usage: gpst track [-h] -o OUT_FILE (--finish-line LAT1 LON1 LAT2 LON2 | --gates-file FILE) [--pit-entry LAT1 LON1 LAT2 LON2] [--pit-exit LAT1 LON1 LAT2 LON2] [--samples N] [--min-lap-points N] [--min-lap-length METERS] [-y] IN_FILE

positional arguments:
  IN_FILE               Path to input file (.gpx, .fit, .vbo).

options:
  -h, --help            show this help message and exit
  -o OUT_FILE, --output OUT_FILE
                        Path to output .track file.
  --finish-line LAT1 LON1 LAT2 LON2
                        Finish gate as 4 values: LAT1 LON1 LAT2 LON2.
  --gates-file FILE     Path to file with [finish_line] and optional [pit_entry]/[pit_exit] sections.
  --pit-entry LAT1 LON1 LAT2 LON2
                        Optional pit entry gate as 4 values: LAT1 LON1 LAT2 LON2.
  --pit-exit LAT1 LON1 LAT2 LON2
                        Optional pit exit gate as 4 values: LAT1 LON1 LAT2 LON2.
  --samples N           Number of points in generated median line (default: 200).
  --min-lap-points N    Minimum points between finish crossings to consider a lap (default: 20).
  --min-lap-length METERS
                        Minimum lap length in meters to consider a lap (default: 50).
  -y, --yes             Accept questions (e.g. overwrite existing output file).

Example:

$ gpst track ./session.vbo -o ./track.track --finish-line 51.05224842382455 16.974045167417728 51.05214967454188 16.974058559964362 --pit-entry 51.052332 16.973482 51.052091 16.973468 --pit-exit 51.052304 16.974400 51.052316 16.974668 -y

Alternative using a gates file (.track format sections are accepted):

$ gpst track ./session.vbo -o ./track.track --gates-file ./auchan.track -y

Limitations

Project details


Download files

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

Source Distribution

gpst-1.1.1.tar.gz (55.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gpst-1.1.1-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

Details for the file gpst-1.1.1.tar.gz.

File metadata

  • Download URL: gpst-1.1.1.tar.gz
  • Upload date:
  • Size: 55.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gpst-1.1.1.tar.gz
Algorithm Hash digest
SHA256 3240b493607312dc4ebb3e6b6627b32710f585349f13918482ccaf85553e19f9
MD5 02c43a6a9fbc44a90dddedc444e8c79f
BLAKE2b-256 58f61e8015705a6fee812b96fd40fcfa9fec0582bbebc85a8d10750c612b8555

See more details on using hashes here.

Provenance

The following attestation bundles were made for gpst-1.1.1.tar.gz:

Publisher: ci.yml on neri14/gpst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gpst-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: gpst-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 56.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gpst-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 86599057348a29ee431bd8c2648111cf0e746ce0ef7815c98210b74a91fdaf7d
MD5 90307b4bd8231e1d798efee0b57961e7
BLAKE2b-256 f7ac202e23818248a0190aa6ed8a8419a5bddc42e9c88b4aa8757c0b02166e33

See more details on using hashes here.

Provenance

The following attestation bundles were made for gpst-1.1.1-py3-none-any.whl:

Publisher: ci.yml on neri14/gpst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page