Skip to main content

r5py: Rapid Realistic Routing with R5 in Python

Try r5py with binder DOI
stable version downloads (pypi) downloads (conda-forge)
Unit tests Documentation Status Coverage

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 R5, 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 R5 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.

SPDX-License-Identifier: GPL-3.0-or-later OR MIT

Release files for r5py 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for r5py 1.0.2
File Size Uploaded
r5py-1.0.2.tar.gz 3.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for r5py 1.0.2
File Interpreter ABI Platform
r5py-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 3.7 MB

Release files / r5py-1.0.2.tar.gz

Download URL r5py-1.0.2.tar.gz
Size 3.7 MB
Tags Source
SHA-256 checksum
How to use checksums
fd8f92084756925bc2f6241a81247dc9efb14278224aa0cfa84c140345d1571c
BLAKE2b-256 checksum
How to use checksums
3c6a68c83873b4901755ebf23924e1aae184169bd01865c79affd70a3534e337
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 14, 2025.

Transparency log

Release files / r5py-1.0.2-py3-none-any.whl

Download URL r5py-1.0.2-py3-none-any.whl
Size 59.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
985dca31b8bbe00bf4754a83d6b86bbccc21541f2bbbfb5f30328599aa0cea81
BLAKE2b-256 checksum
How to use checksums
907e5294a0d6584a32e38d3e59c5be7e17aca49b6e7d5c9a82415d507d43ac7e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 14, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page