doc/html/readme.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>Routino : Software</title>

<!--
 Routino documentation - readme

 Part of the Routino routing software.

 This file Copyright 2008-2017, 2019, 2020, 2023, 2025 Andrew M. Bishop

 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.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see http://www.gnu.org/licenses/.
-->

<link href="style.css" type="text/css" rel="stylesheet">
</head>

<body>

<!-- Header Start -->

<div class="header">

<h1>Routino : Software</h1>

</div>

<!-- Header End -->

<!-- Content Start -->

<div class="content">

<h2 id="H_1_1" title="Introduction">Routino Introduction</h2>

Routino is an application for finding a route between two points using the
dataset of topographical information collected by
<a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">http://www.OpenStreetMap.org</a>.

<p>

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

<p>

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.

<p>

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.

<p>

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
<a class="ext" title="GPX format" href="http://www.topografix.com/gpx.asp">GPX (GPS eXchange) XML format</a>.
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).

<p>

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.


<h2 id="H_1_2">Disclaimer</h2>

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

<p>

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


<h2 id="H_1_3">Demonstration</h2>

A live demonstration of the router for the UK is available on the internet in
both OpenLayers and Leaflet versions:
<br>
<a href="http://www.routino.org/uk-destination-leaflet/" title="Leaflet Router">http://www.routino.org/uk-destination-leaflet/</a>
<br>
<a href="http://www.routino.org/uk-destination-openlayers2/" title="OpenLayers v2 Router">http://www.routino.org/uk-destination-openlayers2/</a>
<br>
<a href="http://www.routino.org/uk-destination-openlayers/" title="OpenLayers Router">http://www.routino.org/uk-destination-openlayers/</a>

<p>

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

<p>

The interactive map is made possible by use of the OpenLayers or Leaflet
Javascript library from
<a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>
or
<a class="ext" href="http://www.openlayers.org/two/" title="OpenLayers">http://www.openlayers.org/two/</a>
or
<a class="ext" href="http://leafletjs.com" title="Leaflet">http://leafletjs.com/</a>.


<h2 id="H_1_4">Documentation</h2>

A full set of
<a href="index.html" title="Documentation">documentation</a>
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.


<h2 id="H_1_5">Status</h2>

Version 1.0 of Routino was released on 8th April 2009.
<br>
Version 2.0 of Routino was released on 30th May 2011.
<br>
Version 3.0 of Routino was released on 12th September 2015.
<br>
Version 3.1 of Routino was released on 5th March 2016.
<br>
Version 3.1.1 of Routino was released on 6th March 2016.
<br>
Version 3.2 of Routino was released on 12th March 2017.
<br>
Version 3.3 of Routino was released on 7th September 2019.
<br>
Version 3.3.1 of Routino was released on 8th September 2019.
<br>
Version 3.3.2 of Routino was released on 18th September 2019.
<br>
Version 3.3.3 of Routino was released on 30th December 2020.
<br>
Version 3.4 of Routino was released on 11th June 2023.
<br>
Version 3.4.1 of Routino was released on 1st July 2023.
<br>
Version 3.4.2 of Routino was released on 29th March 2025.

<p>

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

<h3 id="H_1_5_1" title="Changes 3.4">Changes in Version 3.4</h3>

<dl>
  <dt>Bug fixes:
    <dd>Avoid infinite recursion when parsing route relations.
    <br>Ignore excess data rather than fail to process huge route relations.
  <dt>planetsplitter:
    <dd>Speed up node processing on large databases.
    <br>Merge some steps together to speed up processing.
    <br>Speed up multi-threaded sorting, increase default memory size.
  <dt>OSM tagging:
    <dd>Don't route through barriers (fence, wall etc) explicitly tagged on a node.
    <br>Add platforms (public transport) as highways, equivalent to a path.
    <br>Only look for access tags on barriers not other nodes.
  <dt>Python:
    <dd>Change from distutils to setuptools for building.
    <br>Do not try to install python module with 'make install' but suggest options.
  <dt>Translations:
    <dd>Updated French, Polish, Spanish translations.
    <br>Added Slovak translation.
  <dt>Documentation
    <dd>Recommend multi-threaded sorting.
  <dt>Web pages:
    <dd>Test with the latest version of Leaflet (1.9.4).
    <br>Test with the latest version of OpenLayers (7.4.0).
</dl>

<p>
<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.3.3.


<h3 id="H_1_5_2" title="Changes 3.4.1">Changes in Version 3.4.1</h3>

<dl>
  <dt>Bug fixes:
    <dd>Fix error with sorting (without threads, not slim mode).
</dl>

<p>
<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.4.


<h3 id="H_1_5_3" title="Changes 3.4.2">Changes in Version 3.4.2</h3>

<dl>
  <dt>Bug fixes:
    <dd>Fix bug with using uninitialised memory.
    <br>Fix some problems caused by changing index_t to 64-bit type (not default).
  <dt>planetsplitter:
    <dd>Refactor some code
  <dt>OSM tagging:
    <dd>Rework the node tagging, only consider barriers as blocking access.
  <dt>Translations:
    <dd>Updated Spanish &amp; German translations.
</dl>

<p>
<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.4.1.


<h3 id="H_1_5_4" title="Other Versions">Other Versions</h3>

This version of Routino allows the first and last waypoint of a route
to be on highways with access="destination" or access="private".  The
database is not compatible with the standard version of Routino.


<h2 id="H_1_6">License</h2>

This program is free software: you can redistribute it and/or modify it under
the terms of the
<a class="ext" title="Affero GPLv3" href="http://www.gnu.org/licenses/agpl-3.0.html">GNU Affero General Public License</a>
as published by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version.

<p>

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


<h3 id="H_1_6_1">Copyright</h3>

Routino is copyright Andrew M. Bishop 2008-2025.


<h2 id="H_1_7">Homepage</h2>

The <a title="Homepage" href="http://www.routino.org/">Routino homepage</a>
has the latest news about the program.


<h2 id="H_1_8">Download</h2>

The 'destination-access' version of Routino can only be downloaded from subversion.

<h3 id="H_1_8_1">Subversion</h3>

The source code can be downloaded from the
<a title="SVN Repository" href="http://routino.org/svn/branches/destination-access/">Subversion repository</a>
with a command like the following:

<pre class="boxed">
svn co http://routino.org/svn/branches/destination-access routino-destination-access
</pre>

<p>
The source code can also be browsed in the
<a title="SVN Viewer" href="http://www.routino.org/viewvc/branches/destination-access/">Subversion viewer</a>
which also has a list of the
<a title="SVN Changes" href="http://www.routino.org/viewvc/branches/destination-access/?view=log">latest changes</a>.


</div>

<!-- Content End -->

<!-- Footer Start -->

<div class="footer">

<address>
&copy; Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a>
</address>

</div>

<!-- Footer End -->

</body>

</html>
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2	<html>
3
4	<head>
5	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6	<meta name="viewport" content="width=device-width, initial-scale=1">
7
8	<title>Routino : Software</title>
9
10	<!--
11	Routino documentation - readme
12
13	Part of the Routino routing software.
14
15	This file Copyright 2008-2017, 2019, 2020, 2023, 2025 Andrew M. Bishop
16
17	This program is free software: you can redistribute it and/or modify
18	it under the terms of the GNU Affero General Public License as published by
19	the Free Software Foundation, either version 3 of the License, or
20	(at your option) any later version.
21
22	This program is distributed in the hope that it will be useful,
23	but WITHOUT ANY WARRANTY; without even the implied warranty of
24	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25	GNU Affero General Public License for more details.
26
27	You should have received a copy of the GNU Affero General Public License
28	along with this program. If not, see http://www.gnu.org/licenses/.
29	-->
30
31	<link href="style.css" type="text/css" rel="stylesheet">
32	</head>
33
34	<body>
35
36	<!-- Header Start -->
37
38	<div class="header">
39
40	<h1>Routino : Software</h1>
41
42	</div>
43
44	<!-- Header End -->
45
46	<!-- Content Start -->
47
48	<div class="content">
49
50	<h2 id="H_1_1" title="Introduction">Routino Introduction</h2>
51
52	Routino is an application for finding a route between two points using the
53	dataset of topographical information collected by
54	<a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">http://www.OpenStreetMap.org</a>.
55
56	<p>
57
58	Starting from the raw OpenStreetMap data (in the form of the '.osm' XML files
59	available on the internet) a custom database is generated that contains the
60	information useful for routing. With this database and two points specified by
61	latitude and longitude an optimum route (either shortest or quickest) is
62	determined. The route is calculated for OpenStreetMap highways (roads, paths
63	etc) using one of the common forms of transport defined in OpenStreetMap (foot,
64	bicycle, horse, motorcar, motorcycle etc).
65
66	<p>
67
68	When processing the OpenStreetMap data the types of highways are recorded and
69	these set default limits on the types of traffic allowed. More specific
70	information about permissions for different types of transport are also recorded
71	as are maximum speed limits. Further restrictions like one-way streets, weight,
72	height, width and length limits are also included where specified. Additionally
73	a set of properties of each highway are also recorded. The processing of the
74	input file is controlled by a configuration file which determines the
75	information that is used.
76
77	<p>
78
79	When calculating a route the type of transport to be used is taken into account
80	to ensure that the known restrictions are followed. Each of the different
81	highway types can further be allowed or disallowed depending on preferences.
82	For each type of highway a default speed limit is defined (although the actual
83	speed used will be the lowest of the default and any specified in the original
84	data). To make use of the information about restrictions the weight, height,
85	width and length of the transport can also be specified. Further preferences
86	about road properties (e.g. paved or not) can also be selected. The simplest
87	type of turn restrictions (those formed from an initial way, a node and a second
88	way) are also obeyed.
89
90	<p>
91
92	The result of calculating the route can be presented in several different ways.
93	An HTML file can be produced that contains a description of the route to take
94	with instructions for each of the important junctions. The contents of the file
95	are created based on a set of translations specified in a configuration file.
96	The route is also available in a
97	<a class="ext" title="GPX format" href="http://www.topografix.com/gpx.asp">GPX (GPS eXchange) XML format</a>.
98	format file containing either every point and highway segment (a track file) or
99	just a waypoint and translated instructions for the important junctions (a route
100	file).
101	Additionally there are two plain text files that contain all data points or just
102	the important ones (intended for debugging and further processing).
103
104	<p>
105
106	One of the design aims of Routino was to make the software are flexible as
107	possible in selecting routing preferences but also have a sensible set of
108	default values. Another design aim was that finding the optimum route should be
109	very fast and most of the speed increases come from the carefully chosen and
110	optimised data format.
111
112
113	<h2 id="H_1_2">Disclaimer</h2>
114
115	The route that is calculated by this software is only as good as the input data.
116
117	<p>
118
119	Routino comes with ABSOLUTELY NO WARRANTY for the software itself or the route
120	that is calculated by it.
121
122
123	<h2 id="H_1_3">Demonstration</h2>
124
125	A live demonstration of the router for the UK is available on the internet in
126	both OpenLayers and Leaflet versions:
127	<br>
128	<a href="http://www.routino.org/uk-destination-leaflet/" title="Leaflet Router">http://www.routino.org/uk-destination-leaflet/</a>
129	<br>
130	<a href="http://www.routino.org/uk-destination-openlayers2/" title="OpenLayers v2 Router">http://www.routino.org/uk-destination-openlayers2/</a>
131	<br>
132	<a href="http://www.routino.org/uk-destination-openlayers/" title="OpenLayers Router">http://www.routino.org/uk-destination-openlayers/</a>
133
134	<p>
135
136	The source code download available below also includes a set of files that can
137	be used to create your own interactive map.
138
139	<p>
140
141	The interactive map is made possible by use of the OpenLayers or Leaflet
142	Javascript library from
143	<a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>
144	or
145	<a class="ext" href="http://www.openlayers.org/two/" title="OpenLayers">http://www.openlayers.org/two/</a>
146	or
147	<a class="ext" href="http://leafletjs.com" title="Leaflet">http://leafletjs.com/</a>.
148
149
150	<h2 id="H_1_4">Documentation</h2>
151
152	A full set of
153	<a href="index.html" title="Documentation">documentation</a>
154	is available that describes how to install and use the programs as well as
155	what should go in the configuration files and how it works.
156
157
158	<h2 id="H_1_5">Status</h2>
159
160	Version 1.0 of Routino was released on 8th April 2009.
161	<br>
162	Version 2.0 of Routino was released on 30th May 2011.
163	<br>
164	Version 3.0 of Routino was released on 12th September 2015.
165	<br>
166	Version 3.1 of Routino was released on 5th March 2016.
167	<br>
168	Version 3.1.1 of Routino was released on 6th March 2016.
169	<br>
170	Version 3.2 of Routino was released on 12th March 2017.
171	<br>
172	Version 3.3 of Routino was released on 7th September 2019.
173	<br>
174	Version 3.3.1 of Routino was released on 8th September 2019.
175	<br>
176	Version 3.3.2 of Routino was released on 18th September 2019.
177	<br>
178	Version 3.3.3 of Routino was released on 30th December 2020.
179	<br>
180	Version 3.4 of Routino was released on 11th June 2023.
181	<br>
182	Version 3.4.1 of Routino was released on 1st July 2023.
183	<br>
184	Version 3.4.2 of Routino was released on 29th March 2025.
185
186	<p>
187
188	The full version history is available in the NEWS.txt file.
189
190	<h3 id="H_1_5_1" title="Changes 3.4">Changes in Version 3.4</h3>
191
192	<dl>
193	<dt>Bug fixes:
194	<dd>Avoid infinite recursion when parsing route relations.
195	<br>Ignore excess data rather than fail to process huge route relations.
196	<dt>planetsplitter:
197	<dd>Speed up node processing on large databases.
198	<br>Merge some steps together to speed up processing.
199	<br>Speed up multi-threaded sorting, increase default memory size.
200	<dt>OSM tagging:
201	<dd>Don't route through barriers (fence, wall etc) explicitly tagged on a node.
202	<br>Add platforms (public transport) as highways, equivalent to a path.
203	<br>Only look for access tags on barriers not other nodes.
204	<dt>Python:
205	<dd>Change from distutils to setuptools for building.
206	<br>Do not try to install python module with 'make install' but suggest options.
207	<dt>Translations:
208	<dd>Updated French, Polish, Spanish translations.
209	<br>Added Slovak translation.
210	<dt>Documentation
211	<dd>Recommend multi-threaded sorting.
212	<dt>Web pages:
213	<dd>Test with the latest version of Leaflet (1.9.4).
214	<br>Test with the latest version of OpenLayers (7.4.0).
215	</dl>
216
217	<p>
218	<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.3.3.
219
220
221	<h3 id="H_1_5_2" title="Changes 3.4.1">Changes in Version 3.4.1</h3>
222
223	<dl>
224	<dt>Bug fixes:
225	<dd>Fix error with sorting (without threads, not slim mode).
226	</dl>
227
228	<p>
229	<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.4.
230
231
232	<h3 id="H_1_5_3" title="Changes 3.4.2">Changes in Version 3.4.2</h3>
233
234	<dl>
235	<dt>Bug fixes:
236	<dd>Fix bug with using uninitialised memory.
237	<br>Fix some problems caused by changing index_t to 64-bit type (not default).
238	<dt>planetsplitter:
239	<dd>Refactor some code
240	<dt>OSM tagging:
241	<dd>Rework the node tagging, only consider barriers as blocking access.
242	<dt>Translations:
243	<dd>Updated Spanish & German translations.
244	</dl>
245
246	<p>
247	<b>Note:</b> This version is compatible with databases from versions 2.7.1 - 3.4.1.
248
249
250	<h3 id="H_1_5_4" title="Other Versions">Other Versions</h3>
251
252	This version of Routino allows the first and last waypoint of a route
253	to be on highways with access="destination" or access="private". The
254	database is not compatible with the standard version of Routino.
255
256
257
258	<h2 id="H_1_6">License</h2>
259
260	This program is free software: you can redistribute it and/or modify it under
261	the terms of the
262	<a class="ext" title="Affero GPLv3" href="http://www.gnu.org/licenses/agpl-3.0.html">GNU Affero General Public License</a>
263	as published by the Free Software Foundation; either version 3 of the License,
264	or (at your option) any later version.
265
266	<p>
267
268	It is important to note that for this program I have decided to use the
269	<em>Affero GPLv3</em> instead of just using the GPL. This license adds
270	additional requirements to anybody who provides a networked service using this
271	software.
272
273
274	<h3 id="H_1_6_1">Copyright</h3>
275
276	Routino is copyright Andrew M. Bishop 2008-2025.
277
278
279	<h2 id="H_1_7">Homepage</h2>
280
281	The <a title="Homepage" href="http://www.routino.org/">Routino homepage</a>
282	has the latest news about the program.
283
284
285	<h2 id="H_1_8">Download</h2>
286
287	The 'destination-access' version of Routino can only be downloaded from subversion.
288
289	<h3 id="H_1_8_1">Subversion</h3>
290
291	The source code can be downloaded from the
292	<a title="SVN Repository" href="http://routino.org/svn/branches/destination-access/">Subversion repository</a>
293	with a command like the following:
294
295	<pre class="boxed">
296	svn co http://routino.org/svn/branches/destination-access routino-destination-access
297	</pre>
298
299	<p>
300	The source code can also be browsed in the
301	<a title="SVN Viewer" href="http://www.routino.org/viewvc/branches/destination-access/">Subversion viewer</a>
302	which also has a list of the
303	<a title="SVN Changes" href="http://www.routino.org/viewvc/branches/destination-access/?view=log">latest changes</a>.
304
305
306	</div>
307
308	<!-- Content End -->
309
310	<!-- Footer Start -->
311
312	<div class="footer">
313
314	<address>
315	© Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a>
316	</address>
317
318	</div>
319
320	<!-- Footer End -->
321
322	</body>
323
324	</html>