Metadata-Version: 2.1
Name: gpxplotter
Version: 0.0.3
Summary: A package for reading gpx files and make some simple plots
Home-page: https://github.com/andersle/gpxplotter
Author: Anders Lervik
Author-email: andersle@gmail.com
License: LGPLv2.1+
Keywords: gpx gps
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Other/Nonlisted Topic
Requires-Dist: numpy (>=1.13.1)
Requires-Dist: matplotlib (>=2.2.3)
Requires-Dist: mplleaflet (>=0.0.5)

##########
gpxplotter
##########

``gpxplotter`` is a Python package for reading .gpx [1]_ files and make some simple plots.
It uses `matplotlib <http://matplotlib.org/>`_ to create some simple predefined plots and
`mplleaflet <https://github.com/jwass/mplleaflet>`_ for making maps.


Examples
========

Simple example for plotting an elevation profile with heart rate
----------------------------------------------------------------

.. code:: python

   from gpxplotter import read_gpx_file
   from gpxplotter.mplplotting import plot_elevation_hr_multi_dist, save_fig
   from matplotlib import pyplot as plt
   plt.style.use('seaborn-poster')


   for track in read_gpx_file('test.gpx'):
       for i, segment in enumerate(track['segments']):
           fig = plot_elevation_hr_multi_dist(track, segment)
           save_fig(fig, 'test-{}.png'.format(i))

.. image:: examples/images/test-ele-multi.png
   :scale: 50 %
   :alt: Example output
   :align: center

Simple example for showing a track in a map, colored by heart rate
------------------------------------------------------------------

.. code:: python

   from gpxplotter import read_gpx_file
   from gpxplotter.mplplotting import plot_map, save_map


   for track in read_gpx_file('test.gpx'):
       for i, segment in enumerate(track['segments']):
           fig = plot_map(track, segment, zcolor='pulse')
           save_map(fig, 'test-{}.html'.format(i))


.. image:: examples/images/test-hr-map.png
   :scale: 50 %
   :alt: Example output
   :align: center


Installation
============

gpxplot can be installed via pip:

``pip install gpxplot``


Note
====
The intended usage is for displaying heart rate information together with
other information. If the gpx file does not comtain heart rate information,
the source code will have to be modified accordingly.


References
==========

.. [1] https://en.wikipedia.org/wiki/GPS_Exchange_Format


