Getting started

Get Started in 4 Steps

  1. Install BikeNetLib by following the Installation guide.

  2. To check that the installation worked, run the Minimum working example.

  3. Walk through illustrative examples of BikeNetLib’s features on our Usage pages.

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

Also, if you’re not already familiar with OSMnx and GeoPandas, make sure you read their user guides as BikeNetLib uses their data structures.

Overview of BikeNetLib

BikeNetLib is built on top of OSMnx and GeoPandas. It is imported as bnl and comes with several building blocks:

  • bnl.io – Input and output

  • bnl.utils – Utilities

  • bnl.viz – Visualization

  • bnl.osm – OpenStreetMap constants

To try it out, run the: