e2e279bc85
We need to add quotes around the URL in the curl command (at least in the shell I'm using). Otherwise it truncates the URL at ';'
185 lines
7.1 KiB
Markdown
185 lines
7.1 KiB
Markdown
## Open Source Routing Machine
|
|
|
|
| Linux / macOS | Windows | Code Coverage |
|
|
| ------------- | ------- | ------------- |
|
|
| [](https://travis-ci.org/Project-OSRM/osrm-backend) | [](https://ci.appveyor.com/project/DennisOSRM/osrm-backend) | [](https://codecov.io/gh/Project-OSRM/osrm-backend) |
|
|
|
|
High performance routing engine written in C++14 designed to run on OpenStreetMap data.
|
|
|
|
The following services are available via HTTP API, C++ library interface and NodeJs wrapper:
|
|
- Nearest - Snaps coordinates to the street network and returns the nearest matches
|
|
- Route - Finds the fastest route between coordinates
|
|
- Table - Computes the duration of the fastest route between all pairs of supplied coordinates
|
|
- Match - Snaps noisy GPS traces to the road network in the most plausible way
|
|
- Trip - Solves the Traveling Salesman Problem using a greedy heuristic
|
|
- Tile - Generates Mapbox Vector Tiles with internal routing metadata
|
|
|
|
To quickly try OSRM use our [demo server](http://map.project-osrm.org) which comes with both the backend and a frontend on top.
|
|
|
|
For a quick introduction about how the road network is represented in OpenStreetMap and how to map specific road network features have a look at [this guide about mapping for navigation](https://www.mapbox.com/mapping/mapping-for-navigation/).
|
|
|
|
Related [Project-OSRM](https://github.com/Project-OSRM) repositories:
|
|
- [node-osrm](https://www.npmjs.com/package/osrm) - Production-ready NodeJs bindings for the routing engine
|
|
- [osrm-frontend](https://github.com/Project-OSRM/osrm-frontend) - User-facing frontend with map. The demo server runs this on top of the backend
|
|
- [osrm-text-instructions](https://github.com/Project-OSRM/osrm-text-instructions) - Text instructions from OSRM route response
|
|
- [osrm-backend-docker](https://hub.docker.com/r/osrm/osrm-backend/) - Ready to use Docker images
|
|
|
|
## Documentation
|
|
|
|
### Full documentation
|
|
|
|
- [Hosted documentation](http://project-osrm.org)
|
|
- [osrm-routed HTTP API documentation](docs/http.md)
|
|
- [libosrm API documentation](docs/libosrm.md)
|
|
|
|
## Contact
|
|
|
|
- IRC: `irc.oftc.net`, channel: `#osrm` ([Webchat](https://webchat.oftc.net))
|
|
- Mailinglist: `https://lists.openstreetmap.org/listinfo/osrm-talk`
|
|
|
|
## Quick Start
|
|
|
|
The easiest and quickest way to setup your own routing engine is to use Docker images we provide.
|
|
|
|
### Using Docker
|
|
|
|
We base our Docker images ([backend](https://hub.docker.com/r/osrm/osrm-backend/), [frontend](https://hub.docker.com/r/osrm/osrm-frontend/)) on Alpine Linux and make sure they are as lightweight as possible.
|
|
|
|
Download OpenStreetMap extracts for example from [Geofabrik](http://download.geofabrik.de/)
|
|
|
|
wget http://download.geofabrik.de/europe/germany/berlin-latest.osm.pbf
|
|
|
|
Pre-process the extract with the car profile and start a routing engine HTTP server on port 5000
|
|
|
|
docker run -t -v $(pwd):/data osrm/osrm-backend osrm-extract -p /opt/car.lua /data/berlin-latest.osm.pbf
|
|
docker run -t -v $(pwd):/data osrm/osrm-backend osrm-contract /data/berlin-latest.osrm
|
|
|
|
docker run -t -i -p 5000:5000 -v $(pwd):/data osrm/osrm-backend osrm-routed /data/berlin-latest.osrm
|
|
|
|
Make requests against the HTTP server
|
|
|
|
curl "http://127.0.0.1:5000/route/v1/driving/13.388860,52.517037;13.385983,52.496891?steps=true"
|
|
|
|
Optionally start a user-friendly frontend on port 9966, and open it up in your browser
|
|
|
|
docker run -p 9966:9966 osrm/osrm-frontend
|
|
xdg-open 'http://127.0.0.1:9966'
|
|
|
|
In case Docker complains about not being able to connect to the Docker daemon make sure you are in the `docker` group.
|
|
|
|
sudo usermod -aG docker $USER
|
|
|
|
After adding yourself to the `docker` group make sure to log out and back in again with your terminal.
|
|
|
|
We support the following images on Docker Cloud:
|
|
|
|
Name | Description
|
|
-----|------
|
|
`latest` | `master` compiled with release flag
|
|
`latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols
|
|
`latest-debug` | `master` compiled with debug flag
|
|
`<tag>` | specific tag compiled with release flag
|
|
`<tag>-debug` | specific tag compiled with debug flag
|
|
|
|
### Building from Source
|
|
|
|
The following targets Ubuntu 16.04.
|
|
For instructions how to build on different distributions, macOS or Windows see our [Wiki](https://github.com/Project-OSRM/osrm-backend/wiki).
|
|
|
|
Install dependencies
|
|
|
|
```bash
|
|
sudo apt install build-essential git cmake pkg-config \
|
|
libbz2-dev libstxxl-dev libstxxl1v5 libxml2-dev \
|
|
libzip-dev libboost-all-dev lua5.2 liblua5.2-dev libtbb-dev
|
|
```
|
|
|
|
Compile and install OSRM binaries
|
|
|
|
```bash
|
|
mkdir -p build
|
|
cd build
|
|
cmake ..
|
|
cmake --build .
|
|
sudo cmake --build . --target install
|
|
```
|
|
|
|
Grab a `.osm.pbf` extract from [Geofabrik](http://download.geofabrik.de/index.html) or [Mapzen's Metro Extracts](https://mapzen.com/data/metro-extracts/)
|
|
|
|
```bash
|
|
wget http://download.geofabrik.de/europe/germany/berlin-latest.osm.pbf
|
|
```
|
|
|
|
Pre-process the extract and start the HTTP server
|
|
|
|
```
|
|
osrm-extract berlin-latest.osm.pbf -p profiles/car.lua
|
|
osrm-contract berlin-latest.osrm
|
|
osrm-routed berlin-latest.osrm
|
|
```
|
|
|
|
Running Queries
|
|
|
|
```
|
|
curl "http://127.0.0.1:5000/route/v1/driving/13.388860,52.517037;13.385983,52.496891?steps=true"
|
|
```
|
|
|
|
### Request Against the Demo Server
|
|
|
|
Read the [API usage policy](https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy).
|
|
Simple query with instructions and alternatives on Berlin:
|
|
|
|
```
|
|
curl "https://router.project-osrm.org/route/v1/driving/13.388860,52.517037;13.385983,52.496891?steps=true&alternatives=true"
|
|
```
|
|
|
|
### Using the Node.js Bindings
|
|
|
|
The Node.js bindings provide read-only access to the routing engine.
|
|
We provide API documentation and examples [here](docs/nodejs/api.md).
|
|
|
|
You will need a modern `libstdc++` toolchain (`>= GLIBCXX_3.4.20`) for binary compatibility if you want to use the pre-built binaries.
|
|
For older Ubuntu systems you can upgrade your standard library for example with:
|
|
|
|
```
|
|
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
|
|
sudo apt-get update -y
|
|
sudo apt-get install -y libstdc++-5-dev
|
|
```
|
|
|
|
You can install the Node.js bindings via `npm install osrm` or from this repository either via
|
|
|
|
npm install
|
|
|
|
which will check and use pre-built binaries if they're available for this release and your Node version, or via
|
|
|
|
npm install --build-from-source
|
|
|
|
to always force building the Node.js bindings from source.
|
|
|
|
For usage details have a look [these API docs](docs/nodejs/api.md).
|
|
|
|
|
|
## References in publications
|
|
|
|
When using the code in a (scientific) publication, please cite
|
|
|
|
```
|
|
@inproceedings{luxen-vetter-2011,
|
|
author = {Luxen, Dennis and Vetter, Christian},
|
|
title = {Real-time routing with OpenStreetMap data},
|
|
booktitle = {Proceedings of the 19th ACM SIGSPATIAL International Conference on Advances in Geographic Information Systems},
|
|
series = {GIS '11},
|
|
year = {2011},
|
|
isbn = {978-1-4503-1031-4},
|
|
location = {Chicago, Illinois},
|
|
pages = {513--516},
|
|
numpages = {4},
|
|
url = {http://doi.acm.org/10.1145/2093973.2094062},
|
|
doi = {10.1145/2093973.2094062},
|
|
acmid = {2094062},
|
|
publisher = {ACM},
|
|
address = {New York, NY, USA},
|
|
}
|
|
```
|