Skip to content

Latest commit

 

History

History
134 lines (97 loc) · 4.9 KB

quickstart-from-source.md

File metadata and controls

134 lines (97 loc) · 4.9 KB
Raw

GraphHopper - Quick Start Guide for Developers

Watch this video for a simple introduction.

Try out

For a start which requires only the JRE have a look here. Windows user can find a quick guide here.

Now, before you proceed install git and jdk8, then do:

$ git clone git://github.com/graphhopper/graphhopper.git
$ cd graphhopper; git checkout master
$ ./graphhopper.sh web europe_germany_berlin.pbf
now go to http://localhost:8989/
  1. These steps make the Berlin area routable. It'll download and unzip the osm file for you.
  2. It builds the graphhopper jars. If Maven is not available it will automatically download it.
  3. Then it creates routable files for graphhopper in the folder europe_germany_berlin-gh. It'll skip this step if files are already present.
  4. Also check the instructions for Android

For you favourite area do

$ ./graphhopper.sh web europe_france.pbf
$ ./graphhopper.sh web north-america_us_new-york.pbf
# the format follows the link structure at http://download.geofabrik.de

Start Development

Open the project in your IDE, first class IDEs are NetBeans and IntelliJ where no further setup is required.

Java, Embedded Usage

Have a look into the Java API documentation for further details e.g. how GraphHopper can be embedded into your application and how you create a custom weighting.

Look here for the maven snippet to use GraphHopper in your application. To use an unreleased snapshot version of GraphHopper you need the following snippet in your pom.xml as those versions are not in maven central:

    <repositories>
        <repository>
            <id>sonatype-oss-public</id>
            <url>https://oss.sonatype.org/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

JavaScript

When you started GraphHopper via ./graphhopper.sh web <your_osm.pbf> a web server is already started and waiting for your commands. You can see this for the whole world at GraphHopper Maps.

If you want to change the JavaScript you have to setup the JavaScript environment - i.e. install the node package manager (npm):

For linux do

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash
# close and reopen terminal now
nvm install 4.2.2
nvm use 4.2.2

For windows download either nvm or node directly.

Then generate the main.js

# git clone https://github.com/graphhopper/graphhopper.git
cd graphhopper/web
# download required packages:
npm install
npm test
# overwrites main.js
npm run bundle

Finally start GraphHopper e.g. via the ./graphhopper.sh script and open the browser at localhost:8989.

There are more npm commands e.g. to change the main.js on the fly or create an uglified main.js for production:

# For development just use watchify:
npm run watch

# bundle creates the main file
npm run bundle

# create main.js for debugging
npm run bundleDebug

# create main.js for production and specify as CLI parameter `export NODE_ENV=development` which `options_*.js` should be selected
npm run bundleProduction

# Forcing consistent code style with jshint:
npm run lint

# see the package.json where more scripts are defined

Experimental

If you need offline routing in the browser like for smaller areas or hybrid routing solution then there is a highly experimental version of GraphHopper using TeaVM. Have a look into this blog post for a demo and more information.

Android Usage

For details on Android-usage have a look into this Android site

Swing and Desktop Usage

You can use Graphhopper on the Desktop with the help of mapsforge too. No example code is given yet but with the Android example combined with the Desktop example of the mapsforge project it should not be hard.

For smallish graph (e.g. size of Berlin) use a RAMDataAccess driven GraphStorage (loads all into memory). For larger ones use the ContractionHierarchies preparation class and MMapDataAccess to avoid OutOfMemoryErrors if you have only few RAM.

Raspberry Pi usage is also possible. Have a look into this blog post.

Contribute

See this contributing guide on how to contribute.