X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fhtml%2Freadme.html;fp=doc%2Fhtml%2Freadme.html;h=8dd07127eeed5cd9e08696610157bdc6b454b64a;hb=5a44d59fac1aa6104956f4d5dbeef567169c32c0;hp=0000000000000000000000000000000000000000;hpb=a5b34ad069a52ff6cf981f01667d102292988811;p=routino diff --git a/doc/html/readme.html b/doc/html/readme.html new file mode 100644 index 0000000..8dd0712 --- /dev/null +++ b/doc/html/readme.html @@ -0,0 +1,276 @@ + + + + + + +Routino : Software + + + + + + + + +
+ +

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, motorbike 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 oneway 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 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: +
+http://www.routino.org/uk/ + +

+ +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 Javascript +library from http://www.openlayers.org/. + + +

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. + +

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

Changes in Version 1.5

+ +
+
Bug fixes: +
Check that number of nodes/segments/ways doesn't exceed numerical limits. +
Allow 32-bit systems to seek within files larger than 4GB. +
Allow nearly 4G nodes to be stored instead of 2G before. +
Added rules to makefile for installation (paths specified in top-level). +
Stricter checking of UTF-8 in XML files and better UTF-8 output. +
Improve error message if parsing of command line options fail. +
Fix bugs in router's --help-profile-json and --help-profile-perl options. +
Rename heapsort function to allow compilation on Mac OS with no change. +
Reduce impact of property preferences close to 50% by using sqrt(). + +
Documentation: +
Update documentation to reflect changes in program usage and function. + +
OSM tagging +
Traffic restrictions on nodes are now included in default tagging file. +
Added processing for ferry routes (as pseudo-highway type 'ferry'). +
Process foot and bicycle route relations to create new properties. + +
Configuration Files: +
Added Dutch output translations. +
Added ferry information to profiles. +
Added foot and bicycle route relation processing. + +
planetsplitter +
The slim mode now includes the output data as well as the temporary data. +
The slim mode is now a separate executable and not a command line option. +
Traffic restrictions on nodes are now understood when parsing OSM files. +
Falls back to installed tagging.xml configuration file as last resort. + +
router: +
Added a slim mode (as a separate executable and not a command line option). +
Traffic will not be routed through a node that does not allow it. +
Falls back to installed profiles.xml & translations.xml files as last resort. + +
filedumper: +
Added a slim mode (as a separate executable and not a command line option). + +
Web pages: +
Added Dutch translation of router.html. +
+ +

Additional Changes in Version 1.5.1

+ +
+
Bug fixes: +
Ensure that enough memory is allocated for filenames. +
Fix bug that sometimes causes crash when processing route relations. + +
Documentation: +
Update documentation to reflect changes in program usage and function. + +
Programs: +
Add an option to make the output more suitable for a log file. + +
Documentation: +
Update documentation to reflect changes in program usage. +
+ + +

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-2010. + + +

Download

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