search

ebp-group / walkalytics-clients

Example code for Walkalytics API
https://dev.walkalytics.com
MIT License
3 stars 2 forks source link

readme

Example code for Walkalytics API

Update: We decided to shutdown the public API to https://dev.walkalytics.com. If you are still interested, contact walkalytics@ebp.ch

This is a collection of example code for the Walkalytics API, available at https://dev.walkalytics.com. Signup now for a free API key!

We currently have example code for:

There is also an R wrapper for the API available.

More examples are welcome. Fork this repo and send a pull request.

Setting up an API key file

Create a file walkalytics-api-key in the respective client folder, e.g. in ArcGIS-Desktop if you want to use the ArcGIS Toolbox tool. The API key file has the following format (see also the sample file):

machine api.walkalytics.com login <your dev.walkalytics.com account, i.e. your registered e-mail address> password <your primary key>

You can find your primary key under 'Your Profile & Keys' on https://dev.walkalytics.com.`

Python

Use the file walkalytics-api-key or put the key directly in the source code. Running the code will print the service area, travel time for each POI and an isochrone image as PNG (together with a world file). The coordinate system for the PNG is EPSG:3857.

   > python isochrone.py 828895 5932832

   Source location is (828895,5932832).
   The service area for the source location is 3.45 square km.
   - POI 'Hello!' has a walking time of 0 minutes to the source point.
   - POI 'Is it me you're looking for?' has a walking time of 15 minutes to the source point.
   Save image isochrone_828895_5932832.png with an accompanying world file.

ArcGIS Desktop

The ArcGIS Desktop integration is done by a Python toolbox. In the dialog box, you need to specify a point layer and an output path for the raster (currently only tested with a File Geodatabase). Additionally, input the Walkalytics API key. If a file walkalytics-api-key exists in the ArcGIS-Desktop folder (netrc format, see above), the key is read from there.

The tool Isochrone will read all points in the feature class, calculate the walking isochrone for each point and save the resulting raster is in the output path.

You need to install the PIL module in the path of ArcGIS's Python. Since the original library has not been updated, we we recommend the PIL fork pillow. You can get unofficial Windows binaries here.

OpenLayers

This example shows the walking isochrone on an OpenLayers webmap. To use this example get a "Starter key" from https://dev.walkalytics.com and change the following line in index.html:

<body onload="walkalytics.set_apikey('<your-api-key-here>')">

Run a local webserver in its directory with port 8000, for example with Python:

python -m SimpleHTTPServer 8000

or with node:

npm install http-server -g     # install node module
http-server -p 8000

If you want to run the example on your public webserver, contact mailto:walkalytics@ebp.ch to allow cross-origin resource sharing (CORS) calls for your webserver.

ArcGIS Javascript API

This example shows the walking isochrone on a webmap with ArcGIS Javascript API 3.x. Setting up and testing works as with the OpenLayers example by setting a key and running a local webserver.

Todo: Compare with Esri's routing based Drive Time Analysis and mode walking.

Leaflet

This example shows the walking isochrone on a webmap with Leaflet. Setting up and test works as with the OpenLayers example.

Contributors