R5py

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 it is designed to interact with GeoPandas GeoDataFrames.

R5py offers a simple way to run R5 locally with Python, allowing the 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. Over time, r5py will be expanded to incorporate other functionalities from R5.

Contents

• Installation
  • Install using mamba
  • Install using conda
  • Install using pip
  • Dependencies
• Configuration
  • Configuration via config files
  • Configuration from the command line
  • Using command line options in a script or notebook
  • Configuration/command line options
  • Setting the maximum Java heap size (memory use)
  • Using a custom installation of R5
• Usage
  • Introduction
  • Data requirements
  • Installation
  • Configuring r5py before using it
  • Getting started with r5py
  • Advanced usage
• Contributing to r5py
  • Seven Steps for Contributing
• Code of conduct
  • Our Pledge
  • Our Standards
  • Enforcement Responsibilities
  • Scope
  • Enforcement
  • Enforcement Guidelines
  • Attribution
• License and citation
  • Citation
  • License

Reference

• Module contents