doc/html/index.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 : Documentation</title>

<!--
 Routino documentation - index

 Part of the Routino routing software.

 This file Copyright 2008-2015 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 : Documentation</h1>

</div>

<!-- Header End -->

<!-- Content Start -->

<div class="content">


<h2 id="H_1_1">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 id="H_1_2">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 id="H_1_3">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 id="H_1_4">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 id="H_1_5">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 id="H_1_6">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 id="H_1_7">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 id="H_1_8">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">

<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 : Documentation</title>
9
10	<!--
11	Routino documentation - index
12
13	Part of the Routino routing software.
14
15	This file Copyright 2008-2015 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 : Documentation</h1>
41
42	</div>
43
44	<!-- Header End -->
45
46	<!-- Content Start -->
47
48	<div class="content">
49
50
51	<h2 id="H_1_1">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 id="H_1_2">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 id="H_1_3">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 id="H_1_4">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	preferred speeds etc), tagging rules and translation information for the outputs.
83
84
85	<h2 id="H_1_5">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	<h2 id="H_1_6">Numerical Limits</h2>
93
94	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 id="H_1_7">Algorithm</h2>
100
101	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	<h2 id="H_1_8">Installation</h2>
107
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">
121
122	<address>
123	© Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a>
124	</address>
125
126	</div>
127
128	<!-- Footer End -->
129
130	</body>
131
132	</html>