michaz/r5

Rapid Realistic Routing on Real-world and Reimagined networks

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.michaz:r5:v2.2.0'
	}

	dependencies {
		implementation("com.github.michaz:r5:v2.2.0")
	}

	<dependency>
	    <groupId>com.github.michaz</groupId>
	    <artifactId>r5</artifactId>
	    <version>v2.2.0</version>
	</dependency>


                            
    libraryDependencies += "com.github.michaz" % "r5" % "v2.2.0"


                            
    :dependencies [[com.github.michaz/r5 "v2.2.0"]]

Readme

R5: Rapid Realistic Routing on Real-world and Reimagined networks

R5 is a fast routing engine for multimodal (transit/bike/walk/car) networks. It is currently designed for analytic applications but there are plans to eventually have it support point-to-point journey planning. The routing is "realistic" because it works by planning many trips over a time window, which is more reflective of how people use the transportation system than planning a single trip at an exact departure time---very few people leave for work at precisely 7:53 AM every morning, and even fewer leave at a precise time when going to a non-work event. There's more information on our thinking on this particular point here and here.

Please follow the Conveyal Java style guide at https://github.com/conveyal/JavaStyle/

Javadoc for the project is built automatically after every change and published at http://javadoc.conveyal.com/r5/master/

This is a Maven project, so you'll need to install maven to build R5 before running it. Build instructions are in pom.xml. Once R5 is built (e.g. using mvn clean package), it can be run (e.g. java -jar -Xmx4G target/v3.0.0.jar worker -- see list of commands here).

History

R5 grew out of several open-source projects. The focus on analytic applications, and the core development team behind R5, came from OpenTripPlanner. Many of the algorithms, as well as the name, came from r4.

Building a network

R5 is developed primarily as a routing library for use in other projects (Conveyal Analysis, Modeify etc.) However for testing purposes there are commands to build a network and provide basic routing and visualization of network structure in a web interface. To build a network, place one or more GTFS feeds in a directory together with an OSM PBF file covering the same region. Then run com.conveyal.r5.R5Main point --build /Users/me/path/to/inputs, using the -Xmx switch to give the JVM a GB or two of memory if possible. This will create a file called network.dat in the same directory as the input files. Then run com.conveyal.r5.R5Main point --graphs /path/to/input/files to start up the web server. The routing interface should then be available at http://localhost:8080/, a somewhat more advanced interface at http://localhost:8080/new.html and a vector-based visualization for examining the contents of the network at http://localhost:8080/debug.html. For the debug visualization, you will need to zoom in fairly close before edges are loaded.

Performing a Release

See the section on "performing a release" at https://github.com/conveyal/JavaStyle.