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

Metadata

Release files for r5py 1.0.3

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.3
File Size Uploaded Provenance Actions
r5py-1.0.3.tar.gz 3.7 MB With provenance Details for r5py-1.0.3.tar.gz

Built distribution (wheel)

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

Total release size: 3.8 MB

Release files / r5py-1.0.3.tar.gz

Download URL r5py-1.0.3.tar.gz
Size 3.7 MB
Tags Source
SHA-256 checksum
How to use checksums
b079e1e8369ce16c1df57783dd01c9f809e246d2311ef0796f51b05433677521
BLAKE2b-256 checksum
How to use checksums
d8f283ea4b9854648f7506aeff54cf811ba3e2ec319898b19bae00cacaabffdc
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 31, 2025.

Transparency log

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

Download URL r5py-1.0.3-py3-none-any.whl
Size 59.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d7f0e2262132dbd0c10240b81d91db805bad555cd85fd7d5537540f633a6be9
BLAKE2b-256 checksum
How to use checksums
3ce486e027cb60e6f29cafd792c1ee6427cfdec819706b04be47b61d052db9a6
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 31, 2025.

Transparency log

Security for r5py 1.0.3

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for r5py-1.0.3.tar.gz

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 31, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files Full provenance

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