Cyclograph
==========

CycloGraph is an application for plotting the elevation profile of routes.
Its main value is in the graphical visualization of the difficulty of a
road, in term of slope, difference in height, etc. Plots like these are
often used in cycling competitions, but are also useful in other sports,
such as hiking or running.

website: http://cyclograph.sourceforge.net

System Requirements
--------------------

* Python 3

If you want a graphical interface:

* PyQt 5.x (pyqt5)

or

* gir-1.2-gtk-3.0 (we actively support only X11) and gir-1.2-webkit

N.B.: The Widows installer already ships everything you need.

Usage
-----

* GUI - Graphical User Inteface

`cyclograph`::
    Tries any available graphical interface.

`cyclograph  --qt [-f FILE, --file=FILE]`::
    Executes CycloGraph with qt5 graphic libraries.
    It is possible to open at startup any supported file.

`cyclograph --gtk3 [-f FILE, --file=FILE]`::
    Executes Cyclograph with gtk3 graphic libraries.
    It is possible to open at startup any supported file.


* CLI - Command Line Interface

`cyclograph -f FILE, --file=FILE`::
    Executes Cyclograph with command line interface.
    This require a ciclograph supported file and prints on the standard
    output the svg image rapresenting the slope.

Installation
------------

There are several ways to install CycloGraph, depending on witch package you have downloaded.

cyclograph*.tar.gz
~~~~~~~~~~~~~~~~~~

You can just run cyclograph without installing it with
    python cyclograph/cyclograph [OPTIONS]

If you really want to install it do the followings:
1) Ensure you have the required libraries installed (PyQt5 or gir gtk).
2) Extract the archive.
3) Go into the newly created dirctory and launch the installation process with:
    python setup.py install

This will build CycloGraph for your machine and then install it.
N.B.: This may require superuser priviledges.


cyclograph*.deb
~~~~~~~~~~~~~~~

Use this if you are using Debian or a derived distribution like Ubuntu.
For the installation procedure follow the documentation provided by your distibution.

cyclograph*.exe
~~~~~~~~~~~~~~~

If you are a windows user you may prefer this executable to install a standalone version of cyclograph.

cyclograp*.app
~~~~~~~~~~~~~~

Sadly we cannot provide a packaged app anymore. CycloGraph shoud still work on Mac OS X, if someone is interested in this please email us or the mailing-list.
