Skip to main content

Command line tool for measuring the straightness of a gpx track

Project description

linesman

test coverage Documentation Status

linesman is a small python command line tool calculating quality measures for the straightness of a gpx track. The project is inspired by the "I attempted to cross <country> in a completely straight line" series of youtuber GeoWizard.

Installation

As a python package, linesman is installed with pip. The package is named gpx-linesman:

pip install gpx-linesman

After installing the package, you should be able to run linesman:

linesman --help

Usage

linesman must be passed a gpx file with the recorded track and a quality measure that shall be used to compare the gpx track against the reference line:

linesman path/to/file.gpx <measure>

Currently, the following quality measures are implemented:

  • MAX: maximum deviation from the reference line in meters
  • AVG: average deviation in meters
  • SQ-AVG: squared deviation average in meters

Development

Python dependencies are managed with poetry and can be installed from poetry.lock by running:

poetry install

Then, the CLI tool can be started with poetry run linesman. Run tests with poetry run pytest.

Documentation

Conceptual documentation can be found on readthedocs.

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

gpx-linesman-0.3.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

gpx_linesman-0.3.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file gpx-linesman-0.3.0.tar.gz.

File metadata

  • Download URL: gpx-linesman-0.3.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure

File hashes

Hashes for gpx-linesman-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d86b9d540cfd1b09b7723b90d7fda42349053af1b03357b2c6b2188fe91e1d21
MD5 ba9d334892390e979a90e1b120e0b558
BLAKE2b-256 ac7ca8ab36f9149cb3ece124dd897626ce633e199005e255c6186f4d234d1665

See more details on using hashes here.

File details

Details for the file gpx_linesman-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: gpx_linesman-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.0-1032-azure

File hashes

Hashes for gpx_linesman-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24dc6d2723624df4a3f22bd8fa60d04db58d3270ee0e9b9997317fbf96dc0a17
MD5 79f661a8b61fe1aa906f811b45b5e8ed
BLAKE2b-256 4d7ffe5ef511a70c2eeb9fc4f69d05356f263cfead378d7ae6aa370f6c9dff57

See more details on using hashes here.

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