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">

<title>Routino : Software</title>

<!--
 Routino documentation - readme

 Part of the Routino routing software.

 This file Copyright 2008-2013 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>

<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, 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><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.
<br>
Version 2.4 of Routino was released on 8th December 2012.
<br>
Version 2.4.1 of Routino was released on 17th December 2012.
<br>
Version 2.5 of Routino was released on 9th February 2013.
<br>
Version 2.5.1 of Routino was released on 20th April 2013.
<br>
Version 2.6 of Routino was released on 6th July 2013.

<p>

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


<h3><a name="H_1_5_1" title="Changes"></a>Changes in Versions 2.6</h3>

Version 2.6 - mostly faster operation.

<dl>
  <dt>General:
  <dd>Force '&lt;if&gt;...&lt;/if&gt;' in tagging rules to match even with no input tags.
  <br>Built-in translations for GPX-route file gave nonsense durations.
  <br>Handle some cases that potentially caused divide by zero (not crashes).

  <dt>Compilation:
  <dd>All configuration is now contained in the top level file Makefile.conf.
  <br>Default to using -ffast-math option for faster maths and glibc workaround.

  <dt>Code improvements:
  <dd>Improve router internal data structures to increase performance.
  <br>Add another layer of caching to significantly speed up slim mode operation.
  <br>Add a layer of file buffering to significantly speed up reading/writing.
  <br>Enable more compile-time warnings and fix them.

  <dt>planetsplitter:
  <dd>Create a binary log file to allow searching for errors geographically.
  <br>Simplify processing for changes (segment files not kept).
  <br>Don't prune isolated regions for transport types we don't have.

  <dt>Web pages (visualiser):
  <dd>Allow displaying the error logs on the map.
  <br>Allow selecting any item displayed and showing more information about it.

  <dt>Extras:
  <dd>Create a separate directory to put extra (non-essential) programs and scripts.
    <ul>
      <li>tagmodifier - a tagging rule testing program.
      <li>errorlog - a script to summarise the planetsplitter error log.
      <li>plot-time - a script to plot a graph of the planetsplitter execution time.
      <li>find-fixme - search an OSM file for "fixme" tags and display them on a map.
    </ul>
</dl>

<p>
<b>Note:</b> This version is not compatible with databases from previous versions.


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

Routino is copyright Andrew M. Bishop 2008-2013.


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

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


<h2><a name="H_1_7"></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">
<hr>

<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
7	<title>Routino : Software</title>
8
9	<!--
10	Routino documentation - readme
11
12	Part of the Routino routing software.
13
14	This file Copyright 2008-2013 Andrew M. Bishop
15
16	This program is free software: you can redistribute it and/or modify
17	it under the terms of the GNU Affero General Public License as published by
18	the Free Software Foundation, either version 3 of the License, or
19	(at your option) any later version.
20
21	This program is distributed in the hope that it will be useful,
22	but WITHOUT ANY WARRANTY; without even the implied warranty of
23	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24	GNU Affero General Public License for more details.
25
26	You should have received a copy of the GNU Affero General Public License
27	along with this program. If not, see http://www.gnu.org/licenses/.
28	-->
29
30	<link href="style.css" type="text/css" rel="stylesheet">
31	</head>
32
33	<body>
34
35	<!-- Header Start -->
36
37	<div class="header">
38
39	<h1>Routino : Software</h1>
40
41	<hr>
42	</div>
43
44	<!-- Header End -->
45
46	<!-- Content Start -->
47
48	<div class="content">
49
50	<h2><a name="H_1_1" title="Introduction"></a>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><a name="H_1_2"></a>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><a name="H_1_3"></a>Demonstration</h2>
124
125	A live demonstration of the router for the UK is available on the internet:
126	<br>
127	<a title="Routino demo" href="http://www.routino.org/uk/">http://www.routino.org/uk/</a>
128
129	<p>
130
131	The source code download available below also includes a set of files that can
132	be used to create your own interactive map.
133
134	<p>
135
136	The interactive map is made possible by use of the OpenLayers Javascript
137	library from <a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>.
138
139
140	<h2><a name="H_1_4"></a>Documentation</h2>
141
142	A full set of
143	<a href="index.html" title="Documentation">documentation</a>
144	is available that describes how to install and use the programs as well as
145	what should go in the configuration files and how it works.
146
147
148	<h2><a name="H_1_5"></a>Status</h2>
149
150	Version 1.0 of Routino was released on 8th April 2009.
151	<br>
152	Version 1.1 of Routino was released on 13th June 2009.
153	<br>
154	Version 1.2 of Routino was released on 21st October 2009.
155	<br>
156	Version 1.3 of Routino was released on 21st January 2010.
157	<br>
158	Version 1.4 of Routino was released on 31st May 2010.
159	<br>
160	Version 1.4.1 of Routino was released on 10th July 2010.
161	<br>
162	Version 1.5 of Routino was released on 30th October 2010.
163	<br>
164	Version 1.5.1 of Routino was released on 13th November 2010.
165	<br>
166	Version 2.0 of Routino was released on 30th May 2011.
167	<br>
168	Version 2.0.1 of Routino was released on 7th June 2011.
169	<br>
170	Version 2.0.2 of Routino was released on 26th June 2011.
171	<br>
172	Version 2.0.3 of Routino was released on 4th August 2011.
173	<br>
174	Version 2.1 of Routino was released on 3rd October 2011.
175	<br>
176	Version 2.1.1 of Routino was released on 23rd October 2011.
177	<br>
178	Version 2.1.2 of Routino was released on 12th November 2011.
179	<br>
180	Version 2.2 of Routino was released on 3rd March 2012.
181	<br>
182	Version 2.3 of Routino was released on 21st July 2012.
183	<br>
184	Version 2.3.1 of Routino was released on 11th August 2012.
185	<br>
186	Version 2.3.2 of Routino was released on 6th October 2012.
187	<br>
188	Version 2.4 of Routino was released on 8th December 2012.
189	<br>
190	Version 2.4.1 of Routino was released on 17th December 2012.
191	<br>
192	Version 2.5 of Routino was released on 9th February 2013.
193	<br>
194	Version 2.5.1 of Routino was released on 20th April 2013.
195	<br>
196	Version 2.6 of Routino was released on 6th July 2013.
197
198	<p>
199
200	The full version history is available in the NEWS.txt file.
201
202
203	<h3><a name="H_1_5_1" title="Changes"></a>Changes in Versions 2.6</h3>
204
205	Version 2.6 - mostly faster operation.
206
207	<dl>
208	<dt>General:
209	<dd>Force '<if>...</if>' in tagging rules to match even with no input tags.
210	<br>Built-in translations for GPX-route file gave nonsense durations.
211	<br>Handle some cases that potentially caused divide by zero (not crashes).
212
213	<dt>Compilation:
214	<dd>All configuration is now contained in the top level file Makefile.conf.
215	<br>Default to using -ffast-math option for faster maths and glibc workaround.
216
217	<dt>Code improvements:
218	<dd>Improve router internal data structures to increase performance.
219	<br>Add another layer of caching to significantly speed up slim mode operation.
220	<br>Add a layer of file buffering to significantly speed up reading/writing.
221	<br>Enable more compile-time warnings and fix them.
222
223	<dt>planetsplitter:
224	<dd>Create a binary log file to allow searching for errors geographically.
225	<br>Simplify processing for changes (segment files not kept).
226	<br>Don't prune isolated regions for transport types we don't have.
227
228	<dt>Web pages (visualiser):
229	<dd>Allow displaying the error logs on the map.
230	<br>Allow selecting any item displayed and showing more information about it.
231
232	<dt>Extras:
233	<dd>Create a separate directory to put extra (non-essential) programs and scripts.
234	<ul>
235	<li>tagmodifier - a tagging rule testing program.
236	<li>errorlog - a script to summarise the planetsplitter error log.
237	<li>plot-time - a script to plot a graph of the planetsplitter execution time.
238	<li>find-fixme - search an OSM file for "fixme" tags and display them on a map.
239	</ul>
240	</dl>
241
242	<p>
243	<b>Note:</b> This version is not compatible with databases from previous versions.
244
245
246	<h3><a name="H_1_5_2"></a>License</h3>
247
248	This program is free software: you can redistribute it and/or modify it under
249	the terms of the
250	<a class="ext" title="Affero GPLv3" href="http://www.gnu.org/licenses/agpl-3.0.html">GNU Affero General Public License</a>
251	as published by the Free Software Foundation; either version 3 of the License,
252	or (at your option) any later version.
253
254	<p>
255
256	It is important to note that for this program I have decided to use the
257	<em>Affero GPLv3</em> instead of just using the GPL. This license adds
258	additional requirements to anybody who provides a networked service using this
259	software.
260
261
262	<h3><a name="H_1_5_3"></a>Copyright</h3>
263
264	Routino is copyright Andrew M. Bishop 2008-2013.
265
266
267	<h2><a name="H_1_6"></a>Homepage</h2>
268
269	The <a title="Homepage" href="http://www.routino.org/">Routino homepage</a>
270	has the latest news about the program.
271
272
273	<h2><a name="H_1_7"></a>Download</h2>
274
275	The <a title="Download directory" href="http://www.routino.org/download/">download directory</a>
276	contains the latest version of the source code.
277
278
279	</div>
280
281	<!-- Content End -->
282
283	<!-- Footer Start -->
284
285	<div class="footer">
286	<hr>
287
288	<address>
289	© Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a>
290	</address>
291
292	</div>
293
294	<!-- Footer End -->
295
296	</body>
297
298	</html>