doc/html/readme.html

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

<!--
 Routino documentation - readme

 Part of the Routino routing software.

 This file Copyright 2008-2012 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/.
-->

<HEAD>
<TITLE>Routino : Software</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<LINK href="style.css" type="text/css" rel="stylesheet">
</HEAD>

<BODY>

<!-- Header Start -->

<div class="header" align="center">

<h1>Routino : Software</h1>

<hr>
</div>

<!-- Header End -->

<!-- Content Start -->

<div class="content">

<h2><a name="H_1_1" title="Introduction"></a>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, motorbike 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><a name="H_1_2"></a>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><a name="H_1_3"></a>Demonstration</h2>

A live demonstration of the router for the UK is available on the internet:
<br>
<a title="Routino demo" href="http://www.routino.org/uk/">http://www.routino.org/uk/</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 Javascript
library from <a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>.


<h2><a name="H_1_4"></a>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><a name="H_1_5"></a>Status</h2>

Version 1.0 of Routino was released on 8th April 2009.
<br>
Version 1.1 of Routino was released on 13th June 2009.
<br>
Version 1.2 of Routino was released on 21st October 2009.
<br>
Version 1.3 of Routino was released on 21st January 2010.
<br>
Version 1.4 of Routino was released on 31st May 2010.
<br>
Version 1.4.1 of Routino was released on 10th July 2010.
<br>
Version 1.5 of Routino was released on 30th October 2010.
<br>
Version 1.5.1 of Routino was released on 13th November 2010.
<br>
Version 2.0 of Routino was released on 30th May 2011.
<br>
Version 2.0.1 of Routino was released on 7th June 2011.
<br>
Version 2.0.2 of Routino was released on 26th June 2011.
<br>
Version 2.0.3 of Routino was released on 4th August 2011.
<br>
Version 2.1 of Routino was released on 3rd October 2011.
<br>
Version 2.1.1 of Routino was released on 23rd October 2011.
<br>
Version 2.1.2 of Routino was released on 12th November 2011.
<br>
Version 2.2 of Routino was released on 3rd March 2012.
<br>
Version 2.3 of Routino was released on 21st July 2012.
<br>
Version 2.3.1 of Routino was released on 11th August 2012.
<br>
Version 2.3.2 of Routino was released on 6th October 2012.

<p>

The full version history is available in the NEWS file.


<h3><a name="H_1_5_1" title="Changes"></a>Changes in Versions 2.3, 2.3.1 and 2.3.2</h3>

In version 2.3.2:

<dl>
  <dt>Bug fixes:
  <dd>Fix for highway type visualiser (was missing one-way segments).
  <br>Fix a real-life routing problem with oneway streets and super-segments.
  <br>Find a route even if an end waypoint forbids the specified transport.
  <br>Include the final junction in the HTML output (was missed in some cases).

  <dt>Test cases:
  <dd>Create new test cases for two bugs fixed in this version.

  <dt>router:
  <dd>Improve the error message for some cases of failing to route.

  <dt>planetsplitter:
  <dd>Log an error if a foot/bicycle way doesn't allow foot/bicycle transport.
  <br>Do not mark nodes as super-nodes if they allow no transport types through.

  <dt>Web pages (visualiser):
  <dd>Allow plotting nodes that block each transport type.

  <dt>Configuration Files:
  <dd>Change the default license/copyright notice in the translations.xml file.
</dl>

In version 2.3.1:

<dl>
  <dt>Bug fixes:
  <dd>Create marker-XXX-grey.png icon which gets used before Javascript removes it.
  <br>Provide full set of 99 marker icons instead of just 19.
  <br>Add more limit icons (0.0-0.9, 20.0-40.0 and 161-200).
  <br>Fix router web page problem with placing initial marker (coords not updated).
  <br>Hide waypoints so that they are not visible when Javascript adds them to HTML.
  <br>Fix web page font problems by choosing an explicit font pixel-size in the CSS.
  <br>Fix potential crash in XML files containing lots of key/value pairs in a tag.

  <dt>Web pages (router):
  <dd>Unused waypoints show as blank rather than 0,0.
  <br>Add a button to insert a waypoint to close the loop.
  <br>Write the command line and execution time to the log file.
</dl>

In version 2.3:

<dl>
  <dt>Bug fixes:
  <dd>Handle OSM files that contain changesets (don't raise an error).
  <br>Force bicyle/foot routes to allow bicycle/foot transport.
  <br>Fix problem running CGIs on Macs (md5 program name).
  <br>Fix bug with pruning straight highways (uninitialised data).
  <br>Fix bug with XML parsing error log (could miss some unrecognised tags).

  <dt>Web pages (all):
  <dd>Make compatible with OpenLayers v2.12 (but don't change the install script).
  <br>Make all HTML files standards compliant.
  <br>Allow the HTML files to parse the query string instead of using a CGI.
  <br>Move all user-editable parameters to paths.pl and mapprops.js.

  <dt>Web pages (router):
  <dd>Add a button to put a marker at the current location (Javascript geolocation).
  <br>Add a button to centre the map on a given marker.
  <br>Automatically insert the waypoints in the HTML from the JavaScript.
  <br>Added a German language router web page translation.
  <br>Add buttons to switch between lat/long and placename with Nominatim lookups.

  <dt>Web pages (visualiser):
  <dd>Allow plotting segments of each highway type.
  <br>Allow plotting segments accessible to each transport type.

  <dt>planetsplitter:
  <dd>Add a new '--logtime' option that prints the elapsed time of each step.
  <br>Make the sort functions multi-threaded (run-time option).
  <br>Improve the XML parsing speed slightly.
</dl>

<p>
<b>Note:</b> Existing mapprops.js and paths.pl files need to be updated to
include new items for this version.

<p>
<b>Note:</b> Existing OpenLayers installations must be updated if they were
installed with older Routino provided script (the old OpenLayers.js will not
work).

<p>
<b>Note:</b> The CGI scripts customrouter.cgi and customvisualiser.cgi are
deprecated and will be removed in the next version.

<p>
<b>Note:</b> The noscript.cgi and noscript.html web pages are deprecated and
will be removed in the next version.


<h3><a name="H_1_5_2"></a>License</h3>

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.fsf.org/licensing/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><a name="H_1_5_3"></a>Copyright</h3>

Routino is copyright Andrew M. Bishop 2008-2012.


<h2><a name="H_1_6"></a>Download</h2>

The <a title="Download directory" href="http://www.routino.org/download/">download directory</a>
contains the latest version of the source code.


</div>

<!-- Content End -->

<!-- Footer Start -->

<div class="footer" align="center">
<hr>

<address>
&copy; Andrew M. Bishop = &lt;amb "at" gedanken.demon.co.uk&gt;
</address>

</div>

<!-- Footer End -->

</BODY>

</HTML>
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<HTML>
3
4	<!--
5	Routino documentation - readme
6
7	Part of the Routino routing software.
8
9	This file Copyright 2008-2012 Andrew M. Bishop
10
11	This program is free software: you can redistribute it and/or modify
12	it under the terms of the GNU Affero General Public License as published by
13	the Free Software Foundation, either version 3 of the License, or
14	(at your option) any later version.
15
16	This program is distributed in the hope that it will be useful,
17	but WITHOUT ANY WARRANTY; without even the implied warranty of
18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19	GNU Affero General Public License for more details.
20
21	You should have received a copy of the GNU Affero General Public License
22	along with this program. If not, see http://www.gnu.org/licenses/.
23	-->
24
25	<HEAD>
26	<TITLE>Routino : Software</TITLE>
27	<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
28	<LINK href="style.css" type="text/css" rel="stylesheet">
29	</HEAD>
30
31	<BODY>
32
33	<!-- Header Start -->
34
35	<div class="header" align="center">
36
37	<h1>Routino : Software</h1>
38
39	<hr>
40	</div>
41
42	<!-- Header End -->
43
44	<!-- Content Start -->
45
46	<div class="content">
47
48	<h2><a name="H_1_1" title="Introduction"></a>Routino Introduction</h2>
49
50	Routino is an application for finding a route between two points using the
51	dataset of topographical information collected by
52	<a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">http://www.OpenStreetMap.org</a>.
53
54	<p>
55
56	Starting from the raw OpenStreetMap data (in the form of the '.osm' XML files
57	available on the internet) a custom database is generated that contains the
58	information useful for routing. With this database and two points specified by
59	latitude and longitude an optimum route (either shortest or quickest) is
60	determined. The route is calculated for OpenStreetMap highways (roads, paths
61	etc) using one of the common forms of transport defined in OpenStreetMap (foot,
62	bicycle, horse, motorcar, motorbike etc).
63
64	<p>
65
66	When processing the OpenStreetMap data the types of highways are recorded and
67	these set default limits on the types of traffic allowed. More specific
68	information about permissions for different types of transport are also recorded
69	as are maximum speed limits. Further restrictions like one-way streets, weight,
70	height, width and length limits are also included where specified. Additionally
71	a set of properties of each highway are also recorded. The processing of the
72	input file is controlled by a configuration file which determines the
73	information that is used.
74
75	<p>
76
77	When calculating a route the type of transport to be used is taken into account
78	to ensure that the known restrictions are followed. Each of the different
79	highway types can further be allowed or disallowed depending on preferences.
80	For each type of highway a default speed limit is defined (although the actual
81	speed used will be the lowest of the default and any specified in the original
82	data). To make use of the information about restrictions the weight, height,
83	width and length of the transport can also be specified. Further preferences
84	about road properties (e.g. paved or not) can also be selected. The simplest
85	type of turn restrictions (those formed from an initial way, a node and a second
86	way) are also obeyed.
87
88	<p>
89
90	The result of calculating the route can be presented in several different ways.
91	An HTML file can be produced that contains a description of the route to take
92	with instructions for each of the important junctions. The contents of the file
93	are created based on a set of translations specified in a configuration file.
94	The route is also available in a
95	<a class="ext" title="GPX format" href="http://www.topografix.com/gpx.asp">GPX (GPS eXchange) XML format</a>.
96	format file containing either every point and highway segment (a track file) or
97	just a waypoint and translated instructions for the important junctions (a route
98	file).
99	Additionally there are two plain text files that contain all data points or just
100	the important ones (intended for debugging and further processing).
101
102	<p>
103
104	One of the design aims of Routino was to make the software are flexible as
105	possible in selecting routing preferences but also have a sensible set of
106	default values. Another design aim was that finding the optimum route should be
107	very fast and most of the speed increases come from the carefully chosen and
108	optimised data format.
109
110
111	<h2><a name="H_1_2"></a>Disclaimer</h2>
112
113	The route that is calculated by this software is only as good as the input data.
114
115	<p>
116
117	Routino comes with ABSOLUTELY NO WARRANTY for the software itself or the route
118	that is calculated by it.
119
120
121	<h2><a name="H_1_3"></a>Demonstration</h2>
122
123	A live demonstration of the router for the UK is available on the internet:
124	<br>
125	<a title="Routino demo" href="http://www.routino.org/uk/">http://www.routino.org/uk/</a>
126
127	<p>
128
129	The source code download available below also includes a set of files that can
130	be used to create your own interactive map.
131
132	<p>
133
134	The interactive map is made possible by use of the OpenLayers Javascript
135	library from <a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>.
136
137
138	<h2><a name="H_1_4"></a>Documentation</h2>
139
140	A full set of
141	<a href="index.html" title="Documentation">documentation</a>
142	is available that describes how to install and use the programs as well as
143	what should go in the configuration files and how it works.
144
145
146	<h2><a name="H_1_5"></a>Status</h2>
147
148	Version 1.0 of Routino was released on 8th April 2009.
149	<br>
150	Version 1.1 of Routino was released on 13th June 2009.
151	<br>
152	Version 1.2 of Routino was released on 21st October 2009.
153	<br>
154	Version 1.3 of Routino was released on 21st January 2010.
155	<br>
156	Version 1.4 of Routino was released on 31st May 2010.
157	<br>
158	Version 1.4.1 of Routino was released on 10th July 2010.
159	<br>
160	Version 1.5 of Routino was released on 30th October 2010.
161	<br>
162	Version 1.5.1 of Routino was released on 13th November 2010.
163	<br>
164	Version 2.0 of Routino was released on 30th May 2011.
165	<br>
166	Version 2.0.1 of Routino was released on 7th June 2011.
167	<br>
168	Version 2.0.2 of Routino was released on 26th June 2011.
169	<br>
170	Version 2.0.3 of Routino was released on 4th August 2011.
171	<br>
172	Version 2.1 of Routino was released on 3rd October 2011.
173	<br>
174	Version 2.1.1 of Routino was released on 23rd October 2011.
175	<br>
176	Version 2.1.2 of Routino was released on 12th November 2011.
177	<br>
178	Version 2.2 of Routino was released on 3rd March 2012.
179	<br>
180	Version 2.3 of Routino was released on 21st July 2012.
181	<br>
182	Version 2.3.1 of Routino was released on 11th August 2012.
183	<br>
184	Version 2.3.2 of Routino was released on 6th October 2012.
185
186	<p>
187
188	The full version history is available in the NEWS file.
189
190
191	<h3><a name="H_1_5_1" title="Changes"></a>Changes in Versions 2.3, 2.3.1 and 2.3.2</h3>
192
193	In version 2.3.2:
194
195	<dl>
196	<dt>Bug fixes:
197	<dd>Fix for highway type visualiser (was missing one-way segments).
198	<br>Fix a real-life routing problem with oneway streets and super-segments.
199	<br>Find a route even if an end waypoint forbids the specified transport.
200	<br>Include the final junction in the HTML output (was missed in some cases).
201
202	<dt>Test cases:
203	<dd>Create new test cases for two bugs fixed in this version.
204
205	<dt>router:
206	<dd>Improve the error message for some cases of failing to route.
207
208	<dt>planetsplitter:
209	<dd>Log an error if a foot/bicycle way doesn't allow foot/bicycle transport.
210	<br>Do not mark nodes as super-nodes if they allow no transport types through.
211
212	<dt>Web pages (visualiser):
213	<dd>Allow plotting nodes that block each transport type.
214
215	<dt>Configuration Files:
216	<dd>Change the default license/copyright notice in the translations.xml file.
217	</dl>
218
219	In version 2.3.1:
220
221	<dl>
222	<dt>Bug fixes:
223	<dd>Create marker-XXX-grey.png icon which gets used before Javascript removes it.
224	<br>Provide full set of 99 marker icons instead of just 19.
225	<br>Add more limit icons (0.0-0.9, 20.0-40.0 and 161-200).
226	<br>Fix router web page problem with placing initial marker (coords not updated).
227	<br>Hide waypoints so that they are not visible when Javascript adds them to HTML.
228	<br>Fix web page font problems by choosing an explicit font pixel-size in the CSS.
229	<br>Fix potential crash in XML files containing lots of key/value pairs in a tag.
230
231	<dt>Web pages (router):
232	<dd>Unused waypoints show as blank rather than 0,0.
233	<br>Add a button to insert a waypoint to close the loop.
234	<br>Write the command line and execution time to the log file.
235	</dl>
236
237	In version 2.3:
238
239	<dl>
240	<dt>Bug fixes:
241	<dd>Handle OSM files that contain changesets (don't raise an error).
242	<br>Force bicyle/foot routes to allow bicycle/foot transport.
243	<br>Fix problem running CGIs on Macs (md5 program name).
244	<br>Fix bug with pruning straight highways (uninitialised data).
245	<br>Fix bug with XML parsing error log (could miss some unrecognised tags).
246
247	<dt>Web pages (all):
248	<dd>Make compatible with OpenLayers v2.12 (but don't change the install script).
249	<br>Make all HTML files standards compliant.
250	<br>Allow the HTML files to parse the query string instead of using a CGI.
251	<br>Move all user-editable parameters to paths.pl and mapprops.js.
252
253	<dt>Web pages (router):
254	<dd>Add a button to put a marker at the current location (Javascript geolocation).
255	<br>Add a button to centre the map on a given marker.
256	<br>Automatically insert the waypoints in the HTML from the JavaScript.
257	<br>Added a German language router web page translation.
258	<br>Add buttons to switch between lat/long and placename with Nominatim lookups.
259
260	<dt>Web pages (visualiser):
261	<dd>Allow plotting segments of each highway type.
262	<br>Allow plotting segments accessible to each transport type.
263
264	<dt>planetsplitter:
265	<dd>Add a new '--logtime' option that prints the elapsed time of each step.
266	<br>Make the sort functions multi-threaded (run-time option).
267	<br>Improve the XML parsing speed slightly.
268	</dl>
269
270	<p>
271	<b>Note:</b> Existing mapprops.js and paths.pl files need to be updated to
272	include new items for this version.
273
274	<p>
275	<b>Note:</b> Existing OpenLayers installations must be updated if they were
276	installed with older Routino provided script (the old OpenLayers.js will not
277	work).
278
279	<p>
280	<b>Note:</b> The CGI scripts customrouter.cgi and customvisualiser.cgi are
281	deprecated and will be removed in the next version.
282
283	<p>
284	<b>Note:</b> The noscript.cgi and noscript.html web pages are deprecated and
285	will be removed in the next version.
286
287
288	<h3><a name="H_1_5_2"></a>License</h3>
289
290	This program is free software: you can redistribute it and/or modify it under
291	the terms of the
292	<a class="ext" title="Affero GPLv3" href="http://www.fsf.org/licensing/licenses/agpl-3.0.html">GNU Affero General Public License</a>
293	as published by the Free Software Foundation; either version 3 of the License,
294	or (at your option) any later version.
295
296	<p>
297
298	It is important to note that for this program I have decided to use the
299	<em>Affero GPLv3</em> instead of just using the GPL. This license adds
300	additional requirements to anybody who provides a networked service using this
301	software.
302
303
304	<h3><a name="H_1_5_3"></a>Copyright</h3>
305
306	Routino is copyright Andrew M. Bishop 2008-2012.
307
308
309	<h2><a name="H_1_6"></a>Download</h2>
310
311	The <a title="Download directory" href="http://www.routino.org/download/">download directory</a>
312	contains the latest version of the source code.
313
314
315	</div>
316
317	<!-- Content End -->
318
319	<!-- Footer Start -->
320
321	<div class="footer" align="center">
322	<hr>
323
324	<address>
325	© Andrew M. Bishop = <amb "at" gedanken.demon.co.uk>
326	</address>
327
328	</div>
329
330	<!-- Footer End -->
331
332	</BODY>
333
334	</HTML>