Data

Tools

Indexes

Applications

Experiments

Open Source Science

osrm

A Python wrapper around the OSRM API

https://github.com/ustroetz/python-osrm

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 11 committers (9.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary

Keywords from Contributors

cartography geography solidjs
Last synced: 11 months ago · JSON representation

Repository

A Python wrapper around the OSRM API

Basic Info
  • Host: GitHub
  • Owner: ustroetz
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 205 KB
Statistics
  • Stars: 142
  • Watchers: 11
  • Forks: 52
  • Open Issues: 15
  • Releases: 0
Created about 11 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

python-osrm

A Python wrapper around the OSRM API.

Build Status

  • Provide an easy access to viaroute, table, trip, match and nearest functionnalities.
  • Wrap most of the options of the API (overview, steps, alternatives, etc.).
  • Allow to directly decode geometry to various formats (list of coordinates, WKT, WKB) to be integrated in, let's say, a geo-layer creation with python ogr package.
  • Send coordinates encoded as Polyline as this is the prefered way to query the API.
  • Allow to draw accessibility isochrones around a point (through the utilisation of OSRM table service).
  • Intended to work on python 2.7.x and python 3.
  • Open to suggestions !

Installation

$ pip install osrm

Requires

Linux

  • libgdal-dev

Python packages

  • polyline
  • numpy
  • pandas
  • geopandas
  • GDAL

Running the test suite

python setup.py test

Usage

match

```python In [17]: import osrm

In [18]: points = [(-33.45017046193167,-70.65281867980957), (-33.45239047269638,-70.65300107002258), (-33.453867464504555,-70.65277576446533)]

In [19]: result = osrm.match(points, steps=False, overview="simplified") ```

route

Return the original JSON reponse from OSRM (with optionnaly the geometry decoded in WKT or WKB), allow optionnaly to only output the routes.

```python In [23]: import osrm In [24]: result = osrm.simple_route( [21.0566163803209,42.004088575972], [20.9574645547597, 41.5286973392856], output='route', overview="full", geometry='wkt')

In [25]: result[0]['distance'] Out[25]: 76271

In [26]: result[0]['geometry'] Out[26]: 'LINESTRING (21.056616 42.004088 0,21.056629 42.004078 0,21.056937 42.003885 0, (...) ,20.957376 41.529222 0,20.957172 41.528817 0,20.957466 41.528699 0)' ```

table

A simple wrapping function to fetch the matrix computed by OSRM as a dataframe (or as a numpy array), as well as corrected/snapped localisation of the points used.

```python In [28]: import osrm

In [29]: list_coord = [[21.0566163803209, 42.004088575972], ...: [21.3856064050746, 42.0094518118189], ...: [20.9574645547597, 41.5286973392856], ...: [21.1477394809847, 41.0691482795275], ...: [21.5506463080973, 41.3532256406286]]

In [30]: list_id = ['name1', 'name2', 'name3', 'name4', 'name5']

In [31]: timematrix, snappedcoords = osrm.table(listcoord, idsorigin=list_id, output='dataframe')

In [32]: time_matrix Out[32]: name1 name2 name3 name4 name5 name1 0.0 25.7 69.8 169.7 126.8 name2 26.1 0.0 88.1 149.4 106.3 name3 70.2 88.6 0.0 100.0 65.6 name4 158.4 137.6 99.8 0.0 49.4 name5 115.4 94.6 65.6 48.8 0.0 ```

nearest

```python In [22]: import osrm

In [23]: res = osrm.nearest([22.1021271845936, 41.5078687005805])

In [24]: res Out[24]: {'waypoints': [{'name': 'Friedrichstraße', 'hint': 'niwKgGPotIqSrAAAEAAAABgAAAAGAAAAAAAAAP-KNAepXJkDbrcAAP9LzACoWCEDO0zMAKxYIQMBAAEBfDhq3w==', 'location': [13.388799, 52.517032], 'distance': 4.085341}], 'code': 'Ok'} ```

Accessibility isochrones (based on OSRM table service):

Current options are the number of class and the precision/size of the underlying grid used.

```python In [1]: import osrm

In [2]: Accessibility = osrm.AccessIsochrone((10.00,53.55), points_grid=450)

In [3]: gdf = Accessibility.rendercontour(nclass=8)

In [4]: gdf.plot(cmap="YlOrRd") Out[4]: ```

png

python In [5]: Accessibility.grid.plot() # The grid of points is stored as a GeoDataFrame too Out[5]: <matplotlib.axes._subplots.AxesSubplot at 0x7f134467ae80>

png

Trip

Fetch the full result (with geometry decoded to list, WKT or WKB) or grab only the order of the point to travel from.

```python In [5]: coords = [(13.388860,52.517037), (10.00,53.55), (52.374444,9.738611)]

In [6]: result = osrm.trip(coords, output = "only_index") ```

Using a Point instance to avoid confusion between x/y/latitude/longitude :

```python In [25]: from osrm import Point, simple_route

In [26]: p1 = Point(latitude=2.386459, longitude=48.512369)

In [27]: p2 = Point(latitude=2.536974, longitude=48.793416)

In [28]: result = simple_route(p1, p2) ```

Easily change the host / profile name to query:

By changing the default url :

```python In [31]: import osrm

In [32]: osrm.RequestConfig Out[32]: http://localhost:5000/*/v1/driving

In [33]: osrm.RequestConfig.host = "router.project-osrm.org"

In [34]: result = osrm.simple_route(p1, p2) ```

Or using a new RequestConfig instance, to switch between various url and use basic authentification :

```python In [35]: MyConfig = osrm.RequestConfig("localhost:9999/v1/biking", basic_auth=("user", "pass"))

In [36]: MyConfig Out[36]: localhost:9999/*/v1/biking

In [37]: MyConfig.profile = "driving"

In [38]: MyConfig Out[38]: localhost:9999/*/v1/driving

In [39]: result = osrm.simpleroute(p1, p2, urlconfig=MyConfig) ```

Owner

  • Name: Uli Stroetz
  • Login: ustroetz
  • Kind: user
  • Location: Berlin
  • Company: door2door

GitHub Events

Total
  • Watch event: 11
  • Fork event: 2
Last Year
  • Watch event: 11
  • Fork event: 2

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 81
  • Total Committers: 11
  • Avg Commits per committer: 7.364
  • Development Distribution Score (DDS): 0.765
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Ulrich Stroetz u****z@g****m 19
mthh m****h 15
mz m****c@a****g 13
Teo Stocco t****o@z****m 9
mthh m****y@c****r 9
mthh m****o@a****g 6
janddd j****s@g****m 4
Tonow n****s@g****m 3
Pietro Carnelli p****i@o****m 1
Sergey Ozeranskiy s****y@d****u 1
Frédéric Rodrigo f****o@g****m 1
Committer Domains (Top 20 + Academic)
autistici.org: 2 dreamclass.ru: 1 cnrs.fr: 1 zifeo.com: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 37
  • Total pull requests: 23
  • Average time to close issues: 9 months
  • Average time to close pull requests: 15 days
  • Total issue authors: 30
  • Total pull request authors: 10
  • Average comments per issue: 2.38
  • Average comments per pull request: 1.52
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Rougree (3)
  • hannesaddec (2)
  • zifeo (2)
  • kaleko (2)
  • RnoldR (2)
  • alex6H (2)
  • janddd (1)
  • MaximCamilleri (1)
  • Thecoder352 (1)
  • Marlene98 (1)
  • mtmendoza (1)
  • vrdasari (1)
  • GelmanDan (1)
  • astralcai (1)
  • billylida (1)
Pull Request Authors
  • zifeo (6)
  • mthh (5)
  • ustroetz (4)
  • AlessandroGianfelici (2)
  • Tonow (2)
  • pc0179 (1)
  • janddd (1)
  • frodrigo (1)
  • ozeranskiy (1)
  • gaganjyot (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 311 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 5
  • Total versions: 3
  • Total maintainers: 2
pypi.org: osrm

A Python wrapper around the OSRM API

  • Versions: 3
  • Dependent Packages: 2
  • Dependent Repositories: 5
  • Downloads: 311 Last month
Rankings
Dependent packages count: 3.1%
Forks count: 5.8%
Stargazers count: 6.6%
Dependent repos count: 6.7%
Average: 6.9%
Downloads: 12.2%
Maintainers (2)
zifeo ustroetz
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • GDAL *
  • geopandas *
  • matplotlib *
  • numpy *
  • pandas *
  • polyline *
  • shapely *
setup.py pypi