Routino SVN Repository Browser

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

ViewVC logotype

Contents of /trunk/doc/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2158 - (show annotations) (download)
Sat Jul 1 15:40:50 2023 UTC (20 months, 2 weeks ago) by amb
File MIME type: text/plain
File size: 6989 byte(s)
Update to version 3.4.1.

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 motorcycle 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 one-way 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. The simplest type
37 of turn restrictions (those formed from an initial way, a node and a
38 second way) are also obeyed.
39
40 The result of calculating the route can be presented in several
41 different ways. An HTML file can be produced that contains a
42 description of the route to take with instructions for each of the
43 important junctions. The contents of the file are created based on a
44 set of translations specified in a configuration file. The route is
45 also available in a GPX (GPS eXchange) XML format. format file
46 containing either every point and highway segment (a track file) or
47 just a waypoint and translated instructions for the important junctions
48 (a route file). Additionally there are two plain text files that
49 contain all data points or just the important ones (intended for
50 debugging and further processing).
51
52 One of the design aims of Routino was to make the software are flexible
53 as possible in selecting routing preferences but also have a sensible
54 set of default values. Another design aim was that finding the optimum
55 route should be very fast and most of the speed increases come from the
56 carefully chosen and optimised data format.
57
58
59 Disclaimer
60 ----------
61
62 The route that is calculated by this software is only as good as the
63 input data.
64
65 Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
66 the route that is calculated by it.
67
68
69 Demonstration
70 -------------
71
72 A live demonstration of the router for the UK is available on the
73 internet in both OpenLayers and Leaflet versions:
74
75 http://www.routino.org/uk-leaflet/
76 http://www.routino.org/uk-openlayers2/
77 http://www.routino.org/uk-openlayers/
78
79 The source code download available below also includes a set of files
80 that can be used to create your own interactive map.
81
82 The interactive map is made possible by use of the OpenLayers or
83 Leaflet Javascript library from http://www.openlayers.org/ or
84 http://www.openlayers.org/two/ or http://leafletjs.com/.
85
86
87 Documentation
88 -------------
89
90 The algorithm used is described in the file ALGORITHM.txt with some notes
91 about the input data in DATA.txt and numerical limitations in LIMITS.txt.
92
93 The configuration files and in particular the default set of rules for
94 processing the OpenStreetMap data tags are described in detail in
95 CONFIGURATION.txt and TAGGING.txt. The format of the output files
96 generated are described in OUTPUT.txt.
97
98 Detailed information about how to use the programs is available in the
99 file USAGE.txt and how to install it is in INSTALL.txt.
100
101
102 Status
103 ------
104
105 Version 1.0 of Routino was released on 8th April 2009.
106 Version 2.0 of Routino was released on 30th May 2011.
107 Version 3.0 of Routino was released on 12th September 2015.
108 Version 3.1 of Routino was released on 5th March 2016.
109 Version 3.1.1 of Routino was released on 6th March 2016.
110 Version 3.2 of Routino was released on 12th March 2017.
111 Version 3.3 of Routino was released on 7th September 2019.
112 Version 3.3.1 of Routino was released on 8th September 2019.
113 Version 3.3.2 of Routino was released on 18th September 2019.
114 Version 3.3.3 of Routino was released on 30th December 2020.
115 Version 3.4 of Routino was released on 11th June 2023.
116 Version 3.4.1 of Routino was released on 1st July 2023.
117
118 The full version history is available in the NEWS.txt file.
119
120
121 Other Versions
122 - - - - - - -
123
124 There is a version of Routino (in subversion, on the branch called
125 "destination-access") that allows the first and last waypoint of a
126 route to be on highways with access="destination" or access="private".
127 The database is not compatible with this version of Routino.
128
129
130 License
131 -------
132
133 This program is free software: you can redistribute it and/or modify it
134 under the terms of the GNU Affero General Public License as published
135 by the Free Software Foundation; either version 3 of the License, or
136 (at your option) any later version.
137
138 It is important to note that for this program I have decided to use the
139 Affero GPLv3 instead of just using the GPL. This license adds
140 additional requirements to anybody who provides a networked service
141 using this software.
142
143
144 Copyright
145 ---------
146
147 Routino is copyright Andrew M. Bishop 2008-2023.
148
149
150 Homepage
151 --------
152
153 The Routino homepage has the latest news about the program:
154
155 http://www.routino.org/
156
157
158 Download
159 --------
160
161 The program can be downloaded from:
162
163 http://www.routino.org/download/
164
165 Subversion
166 - - - - -
167
168 The source code can also be downloaded from the Subversion repository
169 with a command like the following:
170
171 svn co http://routino.org/svn/trunk routino
172
173 The source code can also be browsed in the Subversion viewer which also
174 has a list of the latest changes:
175
176 http://www.routino.org/viewvc/trunk/
177 http://www.routino.org/viewvc/trunk/?view=log
178
179
180 --------
181
182 Copyright 2008-2023 Andrew M. Bishop.

Properties

Name Value
cvs:description Main README file.