Routino SVN Repository Browser

Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino

ViewVC logotype

Contents of /branches/2.3.1-dev/doc/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 152 - (show annotations) (download)
Wed Apr 8 18:36:59 2009 UTC (15 years, 11 months ago) by amb
Original Path: trunk/doc/README.txt
File MIME type: text/plain
File size: 4065 byte(s)
Initial revision

1 Routino - OpenStreetMap Routing Software
2 ========================================
3
4 Routino Introduction
5
6 Routino is an application for finding a route between two points using
7 the dataset of topographical information collected by
8 OpenStreetMap.org.
9
10 Starting from the raw OpenStreetMap data (in the form of the .osm
11 XML files available on the internet) a custom database is generated
12 that contains the information useful for routing. With this database
13 and two points specified by latitude and longitude an optimum route
14 (either shortest or quickest) is determined and output as a text
15 description and a track in GPX (GPS eXchange) XML format. The route
16 is calculated for OpenStreetMap highways (roads, paths etc) using one
17 of the common forms of transport defined in OpenStreetMap (foot,
18 bicycle, horse, motorcar, motorbike etc).
19
20 When processing the OpenStreetMap data the types of highways are
21 recorded and these set default limits on the types of traffic allowed.
22 More specific information about permissions for different types of
23 transport are also recorded as are maximum speed limits. Further
24 restrictions like oneway streets, weight, height, width and length
25 limits are also included where specified.
26
27 When calculating a route the type of transport to be used is taken into
28 account to ensure that the known restrictions are followed. Each of the
29 different highway types can further be allowed or disallowed depending
30 on preferences. For each type of highway a default speed limit is
31 defined (although the actual speed used will be the lowest of the
32 default and any specified in the original data). To make use of the
33 information about restrictions the weight, height, width and length of
34 the transport can also be specified.
35
36 One of the design aims of Routino was to make the software are flexible
37 as possible in selecting routing preferences but also have a sensible
38 set of default values. Another design aim was that finding the optimum
39 route should be very fast and most of the speed increases come from the
40 carefully chosen and optimised data format.
41
42 Disclaimer
43
44 The route that is calculated by this software is only as good as the
45 input data.
46
47 Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
48 the route that is calculated.
49
50 Demonstration
51
52 A live demonstration of the router is available on the internet:
53
54 http://www.gedanken.org.uk/mapping/router/router.html
55
56 The source code download available below also includes a set of files
57 that can be used to create your own interactive map.
58
59 The interactive map is made possible by use of the amazing
60 OpenLayers Javascript library.
61
62 Documentation
63
64 The algorithm used and the way that the OpenStreetMap data tags
65 are used are described in detail in their own files, USAGE.txt and
66 TAGGING.txt.
67
68 Detailed information about how to use the programs is available in the
69 file USAGE.txt and how to install it is in INSTALL.txt.
70
71 Status
72
73 Version 1.0 of Routino was released on 8th April 2009.
74
75 License
76
77 This program is free software: you can redistribute it and/or modify it
78 under the terms of the GNU Affero General Public License as
79 published by the Free Software Foundation, either version 3 of the
80 License, or (at your option) any later version.
81
82 It is important to note that for this program I have decided to use the
83 Affero GPLv3 instead of just using the GPL. This license adds
84 additional requirements to anybody who provides a networked service
85 using this software.
86
87 Copyright
88
89 Routino is copyright Andrew M. Bishop 2008,2009.
90
91 Contact amb@gedanken.demon.co.uk for any questions or queries.
92
93 Homepage
94
95 The latest information about the program can be found on the homepage:
96
97 http://www.gedanken.org.uk/software/routino/
98
99 Download
100
101 The program can be downloaded from:
102
103 http://www.gedanken.org.uk/software/routino/download/
104
105
106 --------
107
108 Copyright 2008,2009 Andrew M. Bishop.

Properties

Name Value
cvs:description Main README file.