Getting started

Get Started in 4 Steps

  1. Install LinkBikeNet by following the Installation guide.

  2. Read the Introducing LinkBikeNet section below.

  3. To check that the installation worked, run python examples/mwe.py or the Jupyter Minimum working example.

  4. Consult the User reference for complete details on using the package.

Finally, if you’re not already familiar with NetworkX and GeoPandas, make sure you read their user guides as LinkBikeNet uses their data structures.

Introducing LinkBikeNet

LinkBikeNet is built on top of OSMnx/NetworkX and GeoPandas. It takes one mandatory parameter, the city name, which it passes via Nominatim to OSMnx, to download a city’s street network. LinkBikeNet then runs the following operations:

  • TBA

To try it out, run the: