# Routino : Software

## Routino Introduction

Routino is an application for finding a route between two points using the dataset of topographical information collected by http://www.OpenStreetMap.org.

Starting from the raw OpenStreetMap data (in the form of the '.osm' XML files available on the internet) a custom database is generated that contains the information useful for routing. With this database and two points specified by latitude and longitude an optimum route (either shortest or quickest) is determined. The route is calculated for OpenStreetMap highways (roads, paths etc) using one of the common forms of transport defined in OpenStreetMap (foot, bicycle, horse, motorcar, motorcycle etc).

When processing the OpenStreetMap data the types of highways are recorded and these set default limits on the types of traffic allowed. More specific information about permissions for different types of transport are also recorded as are maximum speed limits. Further restrictions like one-way streets, weight, height, width and length limits are also included where specified. Additionally a set of properties of each highway are also recorded. The processing of the input file is controlled by a configuration file which determines the information that is used.

When calculating a route the type of transport to be used is taken into account to ensure that the known restrictions are followed. Each of the different highway types can further be allowed or disallowed depending on preferences. For each type of highway a default speed limit is defined (although the actual speed used will be the lowest of the default and any specified in the original data). To make use of the information about restrictions the weight, height, width and length of the transport can also be specified. Further preferences about road properties (e.g. paved or not) can also be selected. The simplest type of turn restrictions (those formed from an initial way, a node and a second way) are also obeyed.

The result of calculating the route can be presented in several different ways. An HTML file can be produced that contains a description of the route to take with instructions for each of the important junctions. The contents of the file are created based on a set of translations specified in a configuration file. The route is also available in a GPX (GPS eXchange) XML format. format file containing either every point and highway segment (a track file) or just a waypoint and translated instructions for the important junctions (a route file). Additionally there are two plain text files that contain all data points or just the important ones (intended for debugging and further processing).

One of the design aims of Routino was to make the software are flexible as possible in selecting routing preferences but also have a sensible set of default values. Another design aim was that finding the optimum route should be very fast and most of the speed increases come from the carefully chosen and optimised data format.

## Disclaimer

The route that is calculated by this software is only as good as the input data.

Routino comes with ABSOLUTELY NO WARRANTY for the software itself or the route that is calculated by it.

## Demonstration

A live demonstration of the router for the UK is available on the internet in both OpenLayers and Leaflet versions:
http://www.routino.org/uk-leaflet/
http://www.routino.org/uk-openlayers2/
http://www.routino.org/uk-openlayers/

The source code download available below also includes a set of files that can be used to create your own interactive map.

The interactive map is made possible by use of the OpenLayers or Leaflet Javascript library from http://www.openlayers.org/ or http://www.openlayers.org/two/ or http://leafletjs.com/.

## Documentation

A full set of documentation is available that describes how to install and use the programs as well as what should go in the configuration files and how it works.

## Status

Version 1.0 of Routino was released on 8th April 2009.
Version 1.1 of Routino was released on 13th June 2009.
Version 1.2 of Routino was released on 21st October 2009.
Version 1.3 of Routino was released on 21st January 2010.
Version 1.4 of Routino was released on 31st May 2010.
Version 1.4.1 of Routino was released on 10th July 2010.
Version 1.5 of Routino was released on 30th October 2010.
Version 1.5.1 of Routino was released on 13th November 2010.
Version 2.0 of Routino was released on 30th May 2011.
Version 2.0.1 of Routino was released on 7th June 2011.
Version 2.0.2 of Routino was released on 26th June 2011.
Version 2.0.3 of Routino was released on 4th August 2011.
Version 2.1 of Routino was released on 3rd October 2011.
Version 2.1.1 of Routino was released on 23rd October 2011.
Version 2.1.2 of Routino was released on 12th November 2011.
Version 2.2 of Routino was released on 3rd March 2012.
Version 2.3 of Routino was released on 21st July 2012.
Version 2.3.1 of Routino was released on 11th August 2012.
Version 2.3.2 of Routino was released on 6th October 2012.
Version 2.4 of Routino was released on 8th December 2012.
Version 2.4.1 of Routino was released on 17th December 2012.
Version 2.5 of Routino was released on 9th February 2013.
Version 2.5.1 of Routino was released on 20th April 2013.
Version 2.6 of Routino was released on 6th July 2013.
Version 2.7 of Routino was released on 22nd March 2014.
Version 2.7.1 of Routino was released on 17th May 2014.
Version 2.7.2 of Routino was released on 26th June 2014.
Version 2.7.3 of Routino was released on 8th November 2014.
Version 3.0 of Routino was released on 12th September 2015.
Version 3.1 of Routino was released on 5th March 2016.
Version 3.1.1 of Routino was released on 6th March 2016.
Version 3.2 of Routino was released on 12th March 2017.
Version 3.3 of Routino was released on 7th September 2019.
Version 3.3.1 of Routino was released on 8th September 2019.
Version 3.3.2 of Routino was released on 18th September 2019.
Version 3.3.3 of Routino was released on 30th December 2020.

The full version history is available in the NEWS.txt file.

### Changes in Version 3.3.3

Bug fixes:
  More bug fixes for compiling python library (environment variables).
  Ensure that we do not try memory mapping a zero length file.
  Catch NULL pointers being passed into the library functions.
  Fix some documentation errors.
planetsplitter:
  Reduce memory use by mapping more data from file rather than allocating it.
Python:
  Support the use of the progress callback function when calculating a route.
Translations:
  Updated Czech, Dutch, German and Russian translations.
  Added Finnish translation.
Web pages:
  Zoom to the visible markers from the URL if no lat/long/zoom in the URL.
  Improve the setting / clearing of the cookie for the home location.
  Update the URL when new waypoints are added etc.
  Update the visualiser/fixme data as you move around the map.
  Test with the latest version of Leaflet (1.7.1).
  Add support for the latest version of OpenLayers (6.4.3).

Note: This version is compatible with databases from versions 2.7.1 - 3.3.2.

### Changes in Version 3.3.2

Bug fixes:
  Ensure that parallel compilation works in the python directory.
  Updated the version number in the executables to "3.3.2".

Note: This version is compatible with databases from versions 2.7.1 - 3.3.

### Changes in Version 3.3.1

Bug fixes:
  Ensure that 'make clean' in the python directory deletes auto-generated files.
  Include the python directory in the release file (include in 'FILES').

Note: This version is compatible with databases from versions 2.7.1 - 3.3.

### Changes in Version 3.3

Bug fixes:
  Make the openlayers and leaflet zoom to the same level on clicking the route.
  Add some more memory debug logging (for queue data structure).
  Fix bug with route calculation that may not give optimum solution.
  Fix parallel make to not have failed targets due to 'mkdir' race condition.
  Supress compilation warnings from gcc-7 and gcc-8.
  Supress compilation warnings from clang-5 and clang-5 static analyser.
  Suppress runtime warnings from gcc's runtime sanitizer.
  Bug fix for race condition in multi-threaded sorting algorithm.
  Bug fix for HTML router when named locations are used.
  Fix some error messages for consistency.
  Add extra checks to avoid data overflow and file corruption in planetsplitter.
  Add more checks for memory allocation success/failure.
planetsplitter:
  Do not store nodes in route relations (they are not used).
Documentation:
  Added an extra Perl module that is required.
Translations:
  Updated German, French and Hungarian translations.
  Added Italian and Spanish translations.
  Added incomplete Czech translations.
OSM tagging:
  Some small changes to access tagging and highway naming (prow_ref).
  Add heuristics to decide what transport types are allowed on ferrys.
Web pages:
  Update to use the latest version of Leaflet (1.5.1).
  Add support for the latest version of OpenLayers (5.3).
  Default to showing search boxes for locations not lat/long fields.
Python:
  Created a Python (version 3) interface to the router and routing database.
Extras:
  Update documentation.
  Improve log summarisation HTML page formatting.

Note: This version is compatible with databases from versions 2.7.1 - 3.2.

## License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

It is important to note that for this program I have decided to use the Affero GPLv3 instead of just using the GPL. This license adds additional requirements to anybody who provides a networked service using this software.

### Copyright

Routino is copyright Andrew M. Bishop 2008-2020.

## Homepage

The Routino homepage has the latest news about the program.

## Download

The download directory contains the latest version of the source code.

### Subversion

The source code can also be downloaded from the Subversion repository with a command like the following:

    svn co http://routino.org/svn/trunk routino

The source code can also be browsed in the Subversion viewer which also has a list of the latest changes.