Routino SVN Repository Browser

Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino

ViewVC logotype

Contents of /branches/2.3.1-dev/doc/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 423 - (show annotations) (download)
Mon May 31 14:35:41 2010 UTC (14 years, 9 months ago) by amb
Original Path: trunk/doc/README.txt
File MIME type: text/plain
File size: 5500 byte(s)
Update for version 1.4.

1 Routino - OpenStreetMap Routing Software
2 ========================================
3
4
5 Routino is an application for finding a route between two points using
6 the dataset of topographical information collected by
7 http://www.OpenStreetMap.org.
8
9 Starting from the raw OpenStreetMap data (in the form of the '.osm' XML
10 files available on the internet) a custom database is generated that
11 contains the information useful for routing. With this database and two
12 points specified by latitude and longitude an optimum route (either
13 shortest or quickest) is determined. The route is calculated for
14 OpenStreetMap highways (roads, paths etc) using one of the common forms
15 of transport defined in OpenStreetMap (foot, bicycle, horse, motorcar,
16 motorbike etc).
17
18 When processing the OpenStreetMap data the types of highways are
19 recorded and these set default limits on the types of traffic allowed.
20 More specific information about permissions for different types of
21 transport are also recorded as are maximum speed limits. Further
22 restrictions like oneway streets, weight, height, width and length
23 limits are also included where specified. Additionally a set of
24 properties of each highway are also recorded. The processing of the
25 input file is controlled by a configuration file which determines the
26 information that is used.
27
28 When calculating a route the type of transport to be used is taken into
29 account to ensure that the known restrictions are followed. Each of the
30 different highway types can further be allowed or disallowed depending
31 on preferences. For each type of highway a default speed limit is
32 defined (although the actual speed used will be the lowest of the
33 default and any specified in the original data). To make use of the
34 information about restrictions the weight, height, width and length of
35 the transport can also be specified. Further preferences about road
36 properties (e.g. paved or not) can also be selected.
37
38 The result of calculating the route can be presented in several
39 different ways. An HTML file can be produced that contains a
40 description of the route to take with instructions for each of the
41 important junctions. The contents of the file are created based on a
42 set of translations specified in a configuration file. The route is
43 also available in a GPX (GPS eXchange) XML format. format file
44 containing either every point and highway segment (a track file) or
45 just a waypoint and translated instructions for the important junctions
46 (a route file). Additionally there are two plain text files that
47 contain all data points or just the important ones (intended for
48 debugging and further processing).
49
50 One of the design aims of Routino was to make the software are flexible
51 as possible in selecting routing preferences but also have a sensible
52 set of default values. Another design aim was that finding the optimum
53 route should be very fast and most of the speed increases come from the
54 carefully chosen and optimised data format.
55
56
57 Disclaimer
58 ----------
59
60 The route that is calculated by this software is only as good as the
61 input data.
62
63 Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
64 the route that is calculated.
65
66
67 Demonstration
68 -------------
69
70 A live demonstration of the router is available on the internet:
71
72 http://www.gedanken.org.uk/mapping/routino/router.html
73
74 The source code download available also includes a set of files that can
75 be used to create your own interactive map.
76
77 The interactive map is made possible by use of the OpenLayers Javascript
78 library from http://www.openlayers.org/.
79
80
81 Documentation
82 -------------
83
84 The algorithm used is described in the file ALGORITHM.txt.
85
86 The configuration files and in particular the default set of rules for
87 processing the OpenStreetMap data tags are described in detail in
88 CONFIGURATION.txt and TAGGING.txt. The format of the output files
89 generated are described in OUTPUT.txt.
90
91 Detailed information about how to use the programs is available in the
92 file USAGE.txt and how to install it is in INSTALL.txt.
93
94
95 Status
96 ------
97
98 Version 1.0 of Routino was released on 8th April 2009.
99 Version 1.1 of Routino was released on 13th June 2009.
100 Version 1.2 of Routino was released on 21st October 2009.
101 Version 1.3 of Routino was released on 21st January 2010.
102 Version 1.4 of Routino was released on 31st May 2010.
103
104
105 License
106 -------
107
108 This program is free software: you can redistribute it and/or modify it
109 under the terms of the GNU Affero General Public License as
110 published by the Free Software Foundation, either version 3 of the
111 License, or (at your option) any later version.
112
113 It is important to note that for this program I have decided to use the
114 Affero GPLv3 instead of just using the GPL. This license adds
115 additional requirements to anybody who provides a networked service
116 using this software.
117
118
119 Copyright
120 ---------
121
122 Routino is copyright Andrew M. Bishop 2008-2010.
123
124 Contact amb@gedanken.demon.co.uk for any questions or queries.
125
126
127 Homepage
128 --------
129
130 The latest information about the program can be found on the homepage:
131
132 http://www.gedanken.org.uk/software/routino/
133
134
135 Download
136 --------
137
138 The program can be downloaded from:
139
140 http://www.gedanken.org.uk/software/routino/download/
141
142
143 --------
144
145 Copyright 2008-2010 Andrew M. Bishop.

Properties

Name Value
cvs:description Main README file.