You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+74-32Lines changed: 74 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,7 @@
5
5
GraphHopper is a fast and memory efficient Java road routing engine released under Apache License 2.0.
6
6
Per default it uses OpenStreetMap data but can import other data sources.
7
7
8
-
GraphHopper for the Web
9
-
--------------
8
+
## GraphHopper for the Web
10
9
11
10
See GraphHopper in action on [GraphHopper Maps](https://graphhopper.com/maps)
12
11
@@ -19,63 +18,106 @@ where the default is [Omniscale](http://omniscale.com/), and all is available fo
19
18
for a nice and private route planning experience!
20
19
21
20
22
-
GraphHopper for Mobile
23
-
---------------
21
+
## GraphHopper for Mobile
24
22
25
23
There are subprojects to make GraphHopper working offline
26
24
on [Android](https://github.com/graphhopper/graphhopper/tree/master/android)
27
25
and [iOS](http://github.com/graphhopper/graphhopper-ios)
28
26
29
27
30
-
Get Started
31
-
---------------
28
+
## Get Started
32
29
33
30
Read through our Documentation ([0.6](https://github.com/graphhopper/graphhopper/blob/0.6/docs/index.md), [unstable](https://github.com/graphhopper/graphhopper/blob/master/docs/index.md)),
34
31
ask questions on [Stackoverflow](http://stackoverflow.com/questions/tagged/graphhopper)
35
32
and sign up to the [discussion](https://discuss.graphhopper.com/).
36
33
37
34
38
-
Contribute
39
-
---------------
35
+
## Contribute
40
36
41
37
Read through [how to contribute](https://github.com/graphhopper/graphhopper/blob/master/CONTRIBUTING.md)
42
38
like finding and fixing bugs and improving our documentation or translations!
43
39
44
40
45
-
Features
46
-
---------------
41
+
# Technical Overview
47
42
48
-
* Written in Java
49
-
* Open Source
50
-
* Memory efficient and fast
51
-
* Highly customizable
52
-
* Works on the desktop, as a web service and offline on Android or iOS
53
-
* Large test suite
54
-
55
-
## Overview
56
-
57
-
GraphHopper supports several algorithms like Dijkstra and A* and its bidirectional variants.
58
-
Furthermore it allows you to use Contraction Hierarchies (CH) very easily, we call this
43
+
GraphHopper supports several routing algorithms like
44
+
<ahref="https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm">Dijkstra</a> and
45
+
<ahref="https://en.wikipedia.org/wiki/A*_search_algorithm">A</a>`*` and its bidirectional variants.
46
+
Furthermore it allows you to use
47
+
<ahref="https://en.wikipedia.org/wiki/Contraction_hierarchies">Contraction Hierarchies</a> (CH) very easily, we call this
59
48
**speed mode** and in contrast to the speed mode we call everything without CH the
60
49
**flexibility mode**. BTW: This does not mean that the flexibility mode is *slow*.
61
50
62
-
The speed mode comes with much faster and lightweight (less RAM) responses and it does not use heuristics.
63
-
The downsides are that the speed mode allows only a pre-defined vehicle profile and requires a time
64
-
consuming and resource intense preparation. And implementing certain features are not possible or
65
-
very complex compared to the flexibility mode. But since 0.4 you can use both modes at the same time since.
51
+
The speed mode comes with much faster and lightweight (less RAM) responses and it does not use heuristics in its default settings.
52
+
The downsides are that the speed mode allows only pre-defined vehicle profiles (multiple possible in GraphHopper) and requires a time consuming and resource intense preparation. And implementing certain features are not possible or very complex compared to the flexibility mode. Since 0.4 you can use both modes at the same time.
66
53
See [here](https://github.com/graphhopper/graphhopper/pull/631) for more details.
67
54
55
+
## License
56
+
57
+
We chose the Apache License to make it easy for you to embed GraphHopper in your products.
58
+
We suggest to contribute back your changes, as GraphHopper will evolves fast,
59
+
but of course this is not necessary.
60
+
61
+
## OpenStreetMap Support
62
+
63
+
OpenStreetMap is directly supported from GraphHopper. Without the amazing data from
64
+
OpenStreetMap GraphHopper wouldn't be possible at all.
65
+
Other map data will need a custom import procedure, see e.g. <ahref="https://github.com/graphhopper/graphhopper/issues/277">Ordnance Survey</a>
66
+
or <ahref="https://github.com/knowname/morituri">Navteq</a>.
67
+
68
+
## Written in Java
69
+
70
+
GraphHopper is written in Java and runs on Linux, Mac OS X,
71
+
Windows, BSD, Solaris, Raspberry Pi, Android, Blackberry and even iOS. Other
72
+
environments which supports at least Java 5 will work too.
73
+
74
+
## Customizable
75
+
76
+
We've build the GraphHopper class which makes simple things easy and complex things like multi-modal routing possible. Still you can use the low level API of GraphHopper and you'll see that
77
+
it was created to allow fast and memory efficient use of the underlying datastructures and algorithms.
78
+
79
+
### Android / Blackberry
80
+
81
+
On Android and Blackberry (since 10.2.1) we provide an integration with Mapsforge which makes offline navigation one step closer.
82
+
Due to the usage of memory mapped files and Contraction Hierarchies
83
+
we avoid allocating too much memory which makes it possible to run Germany-wide queries with only
84
+
32MB in a few seconds. We provide an Android studio project as well as the Maven-Android integration to be
85
+
used in other IDEs.
86
+
87
+
### Web UI and API
88
+
89
+
With the web module we provide code to query GraphHopper over HTTP and decrease bandwidth usage as much as possible.
90
+
For that we use the polyline encoding from Google, the Ramer–Douglas–Peucker algorithm and a simple
91
+
GZIP servlet filter.
92
+
On the client side we provide Java and JavaScript code (via Leaflet) to consume that service and
93
+
visualize the routes.
94
+
95
+
### Desktop
96
+
97
+
GraphHopper also runs on the Desktop in a Java application without internet access.
98
+
E.g. you could use the rough user interface called MiniGraphUI provided in the tools module, see some
99
+
visualizations done with it [here](https://graphhopper.com/blog/2016/01/19/alternative-roads-to-rome/).
100
+
A fast and production ready map visualization for the Desktop can be easily implemented via mapsforge.
101
+
102
+
# Features
103
+
68
104
Here is a list of the more detailed features including a link to the documentation:
69
105
70
-
*[a web API](./docs/web/api-doc.md) including JavaScript and Java clients
71
-
* turn instructions in more than 30 languages, contribute or improve [here](./docs/core/translations.md)
*[real time changes to edge weights](https://graphhopper.com/blog/2015/04/08/visualize-and-handle-traffic-information-with-graphhopper-in-real-time-for-cologne-germany-koln/) (flexibility only)
106
+
*[Simple start for users](./docs/web/quickstart.md) - just Java necessary! [Simple start for developers](./docs/core/quickstart-from-source.md) due to Maven.
107
+
* Works out of the box with OpenStreetMap (osm and pbf) but can be adapted to use your own data
108
+
* OpenStreetMap integration: Takes care of the road type, the surface, barriers, access restrictions, ferries, [conditional access restrictions](https://github.com/graphhopper/graphhopper/pull/621), ...
109
+
* GraphHopper is fast. And with the so called "Contraction Hierarchies" it can be even faster (enabled by default).
110
+
* Memory efficient data structures, algorithms and [the low and high level API](./docs/core/low-level-api.md) is tuned towards ease of use and efficiency
111
+
* Provides a simple [web API](./docs/web/api-doc.md) including JavaScript and Java clients
112
+
* Offers turn instructions in more than 30 languages, contribute or improve [here](./docs/core/translations.md)
113
+
* Displays and takes into account [elevation data](./docs/core/elevation.md) (per default disabled)
114
+
* Can apply [real time changes to edge weights](https://graphhopper.com/blog/2015/04/08/visualize-and-handle-traffic-information-with-graphhopper-in-real-time-for-cologne-germany-koln/) (flexibility only)
74
115
* Customized routing profiles per request (flexibility only)
75
-
*A '[heading](./docs/core/routing.md)' for start, end and via points for navigation applications via pass_through or favoredHeading parameters (flexibility only)
116
+
*Possibility to specify a '[heading parameter](./docs/core/routing.md)' for start, end and via points for navigation applications via `pass_through` or `favoredHeading` parameters (flexibility only)
0 commit comments