doc/html/index.html

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

<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>Routino : Documentation</title>

<!--
 Routino documentation - index

 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" align="center">

<h1>Routino : Documentation</h1>

<hr>
</div>

<!-- Header End -->

<!-- Content Start -->

<div class="content">


<h2><a name="H_1_1"></a>Data</h2>

A good router relies on good data and the
<a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">OpenStreetMap</a>
data is a good source.  There are however a number of things that need to be
considered about
<a href="data.html" title="Data considerations">the data used</a>.


<h2><a name="H_1_2"></a>Tagging</h2>

In addition to the raw data the way that are tags are used is also important.
With Routino the
<a title="Tagging" href="tagging.html">tagging rules</a>
are contained in a configuration file and can easily be customised to change the
interpretation of each tag.


<h2><a name="H_1_3"></a>Program Usage</h2>

There are four programs that make up this software, two create the routing
database and use the information in it and the other two perform additional functions.
<a href="usage.html" title="Program Usage">Full instructions</a>
for using the four programs are provided.


<h2><a name="H_1_4"></a>Configuration Files</h2>

When the programs are run they read in one or more
<a href="configuration.html" title="Configuration Files">configuration files</a>.
These files contain information about the routing preferences (types of highways,
preferred speeds etc), tagging rules and translation information for the outputs.


<h2><a name="H_1_5"></a>Output Files</h2>

The final result of running the router is one or more
<a href="output.html" title="Output Files">output files</a>
that contain the calculated route.


<h2><a name="H_1_6"></a>Numerical Limits</h2>

When processing data there are 
<a href="limits.html" title="Numerical Limits">numerical limits</a> for the
range of data identifiers that can be handled and the size of the database.


<h2><a name="H_1_7"></a>Algorithm</h2>

The <a title="Algorithm" href="algorithm.html">algorithm</a> that is used by
Routino takes the OpenStreetMap data and creates a local database of the
important information for rapid routing.


<h2><a name="H_1_8"></a>Installation</h2>

The Routino source code comes with a set of files that can be used to create
a working server very easily.  The full information about
<a href="installation.html" title="Installation">installation</a>
describes how to compile the programs and install them.


</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	amb	584	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2			<HTML>
3
4	amb	1257	<HEAD>
5			<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6
7			<title>Routino : Documentation</title>
8
9	amb	584	<!--
10			Routino documentation - index
11
12			Part of the Routino routing software.
13
14	amb	1257	This file Copyright 2008-2013 Andrew M. Bishop
15	amb	584
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	amb	1257	<link href="style.css" type="text/css" rel="stylesheet">
31	amb	584	</HEAD>
32
33			<BODY>
34
35			<!-- Header Start -->
36
37			<div class="header" align="center">
38
39			<h1>Routino : Documentation</h1>
40
41			<hr>
42			</div>
43
44			<!-- Header End -->
45
46			<!-- Content Start -->
47
48			<div class="content">
49
50
51			<h2><a name="H_1_1"></a>Data</h2>
52
53			A good router relies on good data and the
54			<a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">OpenStreetMap</a>
55			data is a good source. There are however a number of things that need to be
56			considered about
57			<a href="data.html" title="Data considerations">the data used</a>.
58
59
60			<h2><a name="H_1_2"></a>Tagging</h2>
61
62			In addition to the raw data the way that are tags are used is also important.
63			With Routino the
64			<a title="Tagging" href="tagging.html">tagging rules</a>
65			are contained in a configuration file and can easily be customised to change the
66			interpretation of each tag.
67
68
69			<h2><a name="H_1_3"></a>Program Usage</h2>
70
71			There are four programs that make up this software, two create the routing
72			database and use the information in it and the other two perform additional functions.
73			<a href="usage.html" title="Program Usage">Full instructions</a>
74			for using the four programs are provided.
75
76
77			<h2><a name="H_1_4"></a>Configuration Files</h2>
78
79			When the programs are run they read in one or more
80			<a href="configuration.html" title="Configuration Files">configuration files</a>.
81			These files contain information about the routing preferences (types of highways,
82	amb	737	preferred speeds etc), tagging rules and translation information for the outputs.
83	amb	584
84
85			<h2><a name="H_1_5"></a>Output Files</h2>
86
87			The final result of running the router is one or more
88			<a href="output.html" title="Output Files">output files</a>
89			that contain the calculated route.
90
91
92	amb	1250	<h2><a name="H_1_6"></a>Numerical Limits</h2>
93	amb	584
94	amb	1250	When processing data there are
95			<a href="limits.html" title="Numerical Limits">numerical limits</a> for the
96			range of data identifiers that can be handled and the size of the database.
97
98
99			<h2><a name="H_1_7"></a>Algorithm</h2>
100
101	amb	584	The <a title="Algorithm" href="algorithm.html">algorithm</a> that is used by
102			Routino takes the OpenStreetMap data and creates a local database of the
103			important information for rapid routing.
104
105
106	amb	1250	<h2><a name="H_1_8"></a>Installation</h2>
107	amb	584
108			The Routino source code comes with a set of files that can be used to create
109			a working server very easily. The full information about
110			<a href="installation.html" title="Installation">installation</a>
111			describes how to compile the programs and install them.
112
113
114			</div>
115
116			<!-- Content End -->
117
118			<!-- Footer Start -->
119
120			<div class="footer" align="center">
121			<hr>
122
123			<address>
124			© Andrew M. Bishop = <amb "at" gedanken.demon.co.uk>
125			</address>
126
127			</div>
128
129			<!-- Footer End -->
130
131			</BODY>
132
133			</HTML>