.. bikeability documentation master file, created by
   sphinx-quickstart on Fri Nov 10 12:54:20 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Bikeability User Guide
-----------------------

Here you can find information about how to install and use the bikeability package. "Bikeability" is a Python package to automatically compute bike-friendliness of specific areas. With this library, users can download `OpenStreetMap (OSM) <https://www.openstreetmap.org/>`_ data and generate spatial indicators for bikeability (bike facilities on main streets, green share, share of secondary and tertiary roads, node density and bike shop density). Based on these indicators, it is possible to calculate a bikeability index `(Hardinghaus et al. 2021) <https://elib.dlr.de/144713/>`_ using a weighting approach derived from an expert survey.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

Citation
--------

If you use bikeability in your work, please cite the journal article:

Hardinghaus, Michael, et al. "`More than bike lanes—a multifactorial index of urban bikeability. <https://elib.dlr.de/144713/>`_" Sustainability 13.21 (2021): 11584.


Getting Started
---------------

First read the :doc:`getting-started` guide for an introduction to the package and FAQ.

Then work through the 'bikeability Examples'_ gallery for step-by-step tutorials and sample code.

.. _bikeability Examples: https://github.com/DLR-VF/bikeability-examples


Usage
-----
To get started with bikeability, read the user reference and see sample code and input data in
`examples repository <https://github.com/DLR-VF/bikeability-examples>`_.


Features
--------
bikeability is built on top of osmnx, geopandas and networkx.

* Download and prepare geodata from OpenStreetMap
* Calculate spatial indicators of bike-friendliness based on OSM data for a designated area

License
-------

bikeability is open source and licensed under the MIT license. OpenStreetMap's open data `license`_ requires that derivative works provide proper attribution. Refer to the :doc:`getting-started` guide for usage limitations.

.. _license: https://www.openstreetmap.org/copyright



Documentation
-------------

.. toctree::
   :maxdepth: 1

   getting-started

.. toctree::
   :maxdepth: 1

   installation


.. toctree::
   :maxdepth: 1

   bikeability


Indices
-------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`