r5py: Rapid Realistic Routing with R5 in Python

R5py is a Python library for rapid realistic routing on multimodal transport networks (walk, bike, public transport and car). It provides a simple and friendly interface to R⁵, the Rapid Realistic Routing on Real-world and Reimagined networks, the routing engine developed by Conveyal. r5py is inspired by r5r, a wrapper for R, and the library is designed to interact with GeoPandas GeoDataFrames.

R5py offers a simple way to run R5 locally with Python. It allows users to calculate travel time matrices and accessibility by different travel modes. To get started, see a detailed demonstration of the r5py ‘in action’ from the Usage section of its documentation. Over time, r5py will be expanded to incorporate other functionalities from R5.

Installation

R5py is available from conda-forge and PyPi. You can use mamba, pip or conda to install it. To quickstart your use of r5py, we also provide an environment.yml file , using which you can quickly set up a development environment and are ready to go.

For more details and alternative installation options, read the dedicated installation section of the r5py documentation.

Usage

You can find detailed installation instructions, example code, documentation and API reference at r5py.readthedocs.io.

Acknowledgements

The R⁵ routing engine is developed at Conveyal with contributions from several people.

R5py draws a lot of inspiration from r5r, an interface to R5 from the R language that is developed at the Institute for Applied Economic Research (Ipea), Brazil.

Citation

If you use r5py for scientific research, please cite it in your publications:

Fink, C., Klumpenhouwer, W., Saraiva, M., Pereira, R., & Tenkanen, H., 2022: r5py: Rapid Realistic Routing with R5 in Python. DOI:10.5281/zenodo.7060437

License

This work is dual-licensed under GNU General Public License v3.0 or later and MIT License. You can choose between the two depending on which license fits your project better.