Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino
Contents of /trunk/doc/README.txt
Parent Directory
|
Revision Log
Revision 781 -
(show annotations)
(download)
Tue Jun 7 17:31:02 2011 UTC (13 years, 9 months ago) by amb
File MIME type: text/plain
File size: 6016 byte(s)
Tue Jun 7 17:31:02 2011 UTC (13 years, 9 months ago) by amb
File MIME type: text/plain
File size: 6016 byte(s)
Update for version 2.0.1.
1 | Routino : OpenStreetMap Routing Software |
2 | ======================================== |
3 | |
4 | |
5 | Routino is an application for finding a route between two points using |
6 | the dataset of topographical information collected by |
7 | http://www.OpenStreetMap.org. |
8 | |
9 | Starting from the raw OpenStreetMap data (in the form of the '.osm' XML |
10 | files available on the internet) a custom database is generated that |
11 | contains the information useful for routing. With this database and two |
12 | points specified by latitude and longitude an optimum route (either |
13 | shortest or quickest) is determined. The route is calculated for |
14 | OpenStreetMap highways (roads, paths etc) using one of the common forms |
15 | of transport defined in OpenStreetMap (foot, bicycle, horse, motorcar, |
16 | motorbike etc). |
17 | |
18 | When processing the OpenStreetMap data the types of highways are |
19 | recorded and these set default limits on the types of traffic allowed. |
20 | More specific information about permissions for different types of |
21 | transport are also recorded as are maximum speed limits. Further |
22 | restrictions like one-way streets, weight, height, width and length |
23 | limits are also included where specified. Additionally a set of |
24 | properties of each highway are also recorded. The processing of the |
25 | input file is controlled by a configuration file which determines the |
26 | information that is used. |
27 | |
28 | When calculating a route the type of transport to be used is taken into |
29 | account to ensure that the known restrictions are followed. Each of the |
30 | different highway types can further be allowed or disallowed depending |
31 | on preferences. For each type of highway a default speed limit is |
32 | defined (although the actual speed used will be the lowest of the |
33 | default and any specified in the original data). To make use of the |
34 | information about restrictions the weight, height, width and length of |
35 | the transport can also be specified. Further preferences about road |
36 | properties (e.g. paved or not) can also be selected. The simplest type |
37 | of turn restrictions (those formed from an initial way, a node and a |
38 | second way) are also obeyed. |
39 | |
40 | The result of calculating the route can be presented in several |
41 | different ways. An HTML file can be produced that contains a |
42 | description of the route to take with instructions for each of the |
43 | important junctions. The contents of the file are created based on a |
44 | set of translations specified in a configuration file. The route is |
45 | also available in a GPX (GPS eXchange) XML format. format file |
46 | containing either every point and highway segment (a track file) or |
47 | just a waypoint and translated instructions for the important junctions |
48 | (a route file). Additionally there are two plain text files that |
49 | contain all data points or just the important ones (intended for |
50 | debugging and further processing). |
51 | |
52 | One of the design aims of Routino was to make the software are flexible |
53 | as possible in selecting routing preferences but also have a sensible |
54 | set of default values. Another design aim was that finding the optimum |
55 | route should be very fast and most of the speed increases come from the |
56 | carefully chosen and optimised data format. |
57 | |
58 | |
59 | Disclaimer |
60 | ---------- |
61 | |
62 | The route that is calculated by this software is only as good as the |
63 | input data. |
64 | |
65 | Routino comes with ABSOLUTELY NO WARRANTY for the software itself or |
66 | the route that is calculated by it. |
67 | |
68 | |
69 | Demonstration |
70 | ------------- |
71 | |
72 | A live demonstration of the router for the UK is available on the |
73 | internet: |
74 | |
75 | http://www.routino.org/uk/router.html |
76 | |
77 | The source code download available also includes a set of files that can |
78 | be used to create your own interactive map. |
79 | |
80 | The interactive map is made possible by use of the OpenLayers Javascript |
81 | library from http://www.openlayers.org/. |
82 | |
83 | |
84 | Documentation |
85 | ------------- |
86 | |
87 | The algorithm used is described in the file ALGORITHM.txt and some |
88 | notes about the limitations of the data is in DATA.txt. |
89 | |
90 | The configuration files and in particular the default set of rules for |
91 | processing the OpenStreetMap data tags are described in detail in |
92 | CONFIGURATION.txt and TAGGING.txt. The format of the output files |
93 | generated are described in OUTPUT.txt. |
94 | |
95 | Detailed information about how to use the programs is available in the |
96 | file USAGE.txt and how to install it is in INSTALL.txt. |
97 | |
98 | |
99 | Status |
100 | ------ |
101 | |
102 | Version 1.0 of Routino was released on 8th April 2009. |
103 | Version 1.1 of Routino was released on 13th June 2009. |
104 | Version 1.2 of Routino was released on 21st October 2009. |
105 | Version 1.3 of Routino was released on 21st January 2010. |
106 | Version 1.4 of Routino was released on 31st May 2010. |
107 | Version 1.4.1 of Routino was released on 10th July 2010. |
108 | Version 1.5 of Routino was released on 30th October 2010. |
109 | Version 1.5.1 of Routino was released on 13th November 2010. |
110 | Version 2.0 of Routino was released on 30th May 2011. |
111 | Version 2.0.1 of Routino was released on 7th June 2011. |
112 | |
113 | The full version history is available in the NEWS.txt file. |
114 | |
115 | |
116 | License |
117 | ------- |
118 | |
119 | This program is free software: you can redistribute it and/or modify it |
120 | under the terms of the GNU Affero General Public License as published |
121 | by the Free Software Foundation; either version 3 of the License, or |
122 | (at your option) any later version. |
123 | |
124 | It is important to note that for this program I have decided to use the |
125 | Affero GPLv3 instead of just using the GPL. This license adds |
126 | additional requirements to anybody who provides a networked service |
127 | using this software. |
128 | |
129 | |
130 | Copyright |
131 | --------- |
132 | |
133 | Routino is copyright Andrew M. Bishop 2008-2011. |
134 | |
135 | Contact amb@gedanken.demon.co.uk for any questions or queries. |
136 | |
137 | |
138 | Homepage |
139 | -------- |
140 | |
141 | The latest information about the program can be found on the homepage: |
142 | |
143 | http://www.routino.org/ |
144 | |
145 | |
146 | Download |
147 | -------- |
148 | |
149 | The program can be downloaded from: |
150 | |
151 | http://www.routino.org/download/ |
152 | |
153 | |
154 | -------- |
155 | |
156 | Copyright 2008-2011 Andrew M. Bishop. |
Properties
Name | Value |
---|---|
cvs:description | Main README file. |