Getting Started¶

Get Started in 4 Steps¶

Install bikeability by following the Installation guide.
Read the introduction below on this page.
Work through the bikebility Examples gallery for step-by-step tutorials and sample code.
Consult the User reference for complete details on using the package.

Finally, if you’re not already familiar with OSMnx, NetworkX and GeoPandas, we would advise to check out their functionality.

Introducing bikeability¶

Configuration¶

You can configure bikebility using the settings module. Here, you are able to change osm tags to download specific OSM data, the directory to store temporary data and the default projection.

Downloading OpenStreetMap Data¶

Bikeability uses osmnx to download street networks, green spaces and bike shops from OpenStreetMap. osmnx geocodes place names and addresses with the OpenStreetMap Nominatim API and enables the download of specific OSM data via Overpass API.

Amenities of bikeability¶

Bikeability is a tool to automatically derive bike-related infrastructures from OpenStreetMap and calculate an index reflecting the bike-friendliness of a chosen area, the so-called “Bikeabilit Index”. In general, four types of infrastructures are included in the index:

the share of green-spaces,
the percentage of bicycle infrastructures on main streets,
the share of secondary and tertiary roads,
and the density of bicycle-related shops (rental, buy, repair).

More Info¶

All of this functionality is demonstrated step-by-step in the bikeability Examples gallery, and usage is detailed in the User reference.

Frequently Asked Questions¶

Are there any usage limitations? Yes. Refer to the Nominatim Usage Policy and Overpass Commons documentation for usage limitations and restrictions that you must adhere to at all times. If you use an alternative Nominatim/Overpass instance, ensure you understand and obey their usage policies. If you need to exceed these limitations, consider installing your own hosted instance and setting bikebilityto use it.