osrm

node-osrm

Routing engine for OpenStreetMap data implementing high-performance algorithms for shortest paths in road networks.

Provides bindings to the Open Source Routing Machine - OSRM.

Depends

• Node.js v0.10.x or v0.8.x

Installing

By default, binaries are provided for:

• 64 bit OS X and 64 bit Linux
• Node v0.8.x and v0.10.x

On those platforms no external dependencies are needed.

Just do:

npm install osrm

However other platforms will fall back to a source compile: see Source Build for details.

Usage

The node-osrm module consumes data processed by OSRM core.

This repository contains a Makefile that does this automatically:

• Downloads an OSM extract
• Runs osrm-extract and osrm-prepare
• Has a OSRM config (ini) file that references the prepared data

Just run:

make berlin-latest.osrm.hsgr

Once that is done then you can calculate routes in Javascript like:

// Note: to require osrm locally do:
// require('./lib/osrm.js')
var osrm = require('osrm')
var opts = new osrm.Options("./test/data/berlin.ini");
var engine = new osrm.Engine(opts);
var query = new osrm.Query({coordinates: [[52.519930,13.438640], [52.513191,13.415852]]});
var sync_result = engine.run(query);
JSON.parse(engine.run(query));
{ status: 0,
  status_message: 'Found route between points',
  route_geometry: '{~pdcBmjfsXsBrD{KhS}DvHyApCcf@l}@kg@z|@_MbX|GjHdXh^fm@dr@~\\l_@pFhF|GjCfeAbTdh@fFqRp}DoEn\\cHzR{FjLgCnFuBlG{AlHaAjJa@hLXtGnCnKtCnFxCfCvEl@lHBzA}@vIoFzCs@|CcAnEQ~NhHnf@zUpm@rc@d]zVrTnTr^~]xbAnaAhSnPgJd^kExPgOzk@maAx_Ek@~BuKvd@cJz`@oAzFiAtHvKzAlBXzNvB|b@hGl@Dha@zFbGf@fBAjQ_AxEbA`HxBtPpFpa@rO_Cv_B_ZlD}LlBGB',
  route_instructions: 
   [ ... ],
  route_summary: 
   { total_distance: 2814,
     total_time: 211,
     start_point: 'Friedenstraße',
     end_point: 'Am Köllnischen Park' },
  alternative_geometries: [],
  alternative_instructions: [],
  alternative_summaries: [],
  route_name: 
   [ 'Lichtenberger Straße',
     'Holzmarktstraße' ],
  alternative_names: [ [ '', '' ] ],
  via_points: 
   [ [ 52.519934, 13.438647 ],
     [ 52.513162, 13.415509 ] ],
  via_indices: [ 0, 69 ],
  alternative_indices: [],
  hint_data: 
   { checksum: 222545162,
     locations: 
      [ '9XkCAJgBAAAtAAAA____f7idcBkPGuw__mMhA7cOzQA',
        'TgcEAFwFAAAAAAAAVAAAANIeb5DqBHs_ikkhA1W0zAA' ] } }

Source Build

To build from source you will need:

• OSRM develop branch, cloned from github.
• OSRM build with -DWITH_TOOLS=1 so that libOSRM is created
• Lua, luabind, and stxxl headers

To build with OS X Mavericks you need to ensure the bindings link to libc++. An easy way to do this is to set:

export CXXFLAGS=-mmacosx-version-min=10.9

before building node-osrm.

Building

To build the bindings you need to first build and install the develop branch of Project-OSRM:

# grab develop branch
git clone -b develop https://github.com/DennisOSRM/Project-OSRM.git
cd Project-OSRM
mkdir build;
cd build;
cmake ../ -DWITH_TOOLS=1
make
sudo make install

NOTE: If you hit problems building Project-OSRM see the wiki for details.

Then build node-osrm against Project-OSRM installed in /usr/local:

git clone https://github.com/DennisOSRM/node-osrm.git
cd node-osrm
npm install

Developing

Developers of node-osrm should set up a Source Build and after changes to the code run:

make

Under the hood this uses node-gyp to compile the source code.

Releasing a new version of node-osrm requires:

1. Changing the package.json version: either increment the version of remove the -alpha flag
2. Tagging a new release with git: git tag v0.3.0 -m "Tagging v0.3.0
3. Pushing the tag to github: git push --tags

After pushing the tag Travis.ci will automatically:

• Build binaries and publish them to S3 with node-pre-gyp
• Run tests, and upon success
• Will run npm publish to push the package to the npm registry

Testing

Run the tests like:

make test