r5py 0.0.3

Python wrapper for the R5 routing analysis engine

r5py: Rapid Realistic Routing with R5 in Python

R5py is a Python wrapper for the R5 routing analysis engine. It’s inspired by r5r, a wrapper for R, and is designed to interact with GeoPandas data frames.

Similar to r5r, r5py represents a simple way to run R5 locally. It allows users to generate detailed routing analyses or calculate travel time matrices using parallel computing, and integrates seamlessly with Python/Geopandas workflows.

Installation

Install r5py from PyPi, e.g., using pip:

pip install r5py

You also need to install a Java Development Kit, for instance, OpenJDK, in version 11. If you are on Linux, please use the jdk provided by your operating system’s package manager.

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.

License

This work is dual-licensed under GNU General Public License v3.0 or later and MIT License. You can choose between one of them if you use this work.

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