Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Latest commit

 

History

History
49 lines (32 loc) · 5.35 KB

README.md

File metadata and controls

49 lines (32 loc) · 5.35 KB

Important

This fork of OpenTripPlanner v1 was maintained by the MBTA for many years to power trip planning on the MBTA website. In migrating to v2 in 2023, we found ourselves no longer in need of our own fork.

Overview

OpenTripPlanner (OTP) is an open source multi-modal trip planner. It depends on open data in open standard file formats (GTFS and OpenStreetMap), and includes a REST API for journey planning as well as a map-based Javascript client. OpenTripPlanner can also create travel time contour visualizations and compute accessibility indicators for planning and research applications. For more information, see the project website: http://opentripplanner.org

The main Java server code is in src/main/. OTP also includes a Javascript client based on the Leaflet mapping library in src/client/. The Maven build produces a JAR file at target/otp-VERSION.jar containing all necessary code and dependencies to run OpenTripPlanner.

Additional information and instructions are available in the main documentation, including a quick introduction.

Build Status

MBTA Fork Setup

You'll need to clone this repo and the onebusaway-gtfs-modules repo. From the onebusaway-gtfs-modules directory do:

  1. asdf plugin add java
  2. asdf plugin add maven
  3. asdf install
  4. ./build.sh

This last step will take care of building the modules and installing them locally, which is necessary for the next step: building and running OTP. From the OTP directory:

  1. asdf install
    • If you're trying this on a Mac with an Apple silicon chip, asdf won't be able to install the JDK-8 version specified in .tool-versions, because there's no arm64 build available.
    • Run arch -x86_64 <path to your shell, ex. /bin/zsh> to use Rosetta, then run asdf install again.
    • After this completes successfully, exit the Rosetta shell and continue with the next steps.
  2. mbta/update_gtfs.sh - fetches latest MBTA and Massport GTFS data
  3. mbta/update_pbf.sh - updates OpenStreetMap data
  4. mbta/build.sh

If you want to test with your own local GTFS changes, simply put a copy of your GTFS file (the Google output) in var/graphs/mbta/1_MBTA_GTFS.zip and re-run the build.sh script.

Running

With all of that setup done, you should be able to run mbta/server.sh. This will start your local OTP instance and, when ready, print a message saying that the web server is ready and listening. Open a browser pointing to localhost at the port specified and you'll have a barebones web interface to OTP where you can try out various trip plans.

Development

OpenTripPlanner is a collaborative project incorporating code, translation, and documentation from contributors around the world. We welcome new contributions and prefer to format our code according to GeoTools-based formatting guidelines; an Eclipse autoformatter can be found at the root of this project (https://raw.github.com/openplans/OpenTripPlanner/master/formatter.xml). Further development guidelines can be found in the documentation.

The OpenTripPlanner project was launched by Portland, Oregon's transport agency TriMet (http://trimet.org/), and began in July of 2009 with a kick-off conference bringing together transit agencies and the authors of the major open source transit passenger information software of the day: David Emory of FivePoints, Brian Ferris of OneBusAway, and Brandon Martin-Anderson of GraphServer. From 2008 through 2012, development was coordinated by New York nonprofit OpenPlans (http://openplans.org/). By early 2013, OpenTripPlanner had become the primary trip planning software used by TriMet in the Portland regional trip planner (http://ride.trimet.org/) and was backing several popular mobile applications. Public-facing OpenTripPlanner instances were available in at least ten countries throughout the world. At this point the OpenPlans transportation software team became the independent consultancy Conveyal (http://www.conveyal.com/). The original OpenTripPlanner development team from OpenPlans still actively participates in programming, design, and community coordination via the mailing list and their roles on the OTP Project Leadership Committee.

In summer of 2013, the OpenTripPlanner project was accepted for membership in the Software Freedom Conservancy (SFC). SFC handles the legal and financial details common to many open source projects, providing a formal framework for OTP and allowing contributors to concentrate on the code. For more information, see the SFC website at http://sfconservancy.org/.

After seven years of hard work and almost 10,000 commits from over 100 contributors around the world, version 1.0 was released on 9 September 2016.

Mailing Lists

The main forums through which the OpenTripPlanner community organizes development and provides mutual assistance are our two Google discussion groups. Changes and extensions to OTP are debated on the developers' list (opentripplanner-dev). More general questions and announcements of interest to non-developer OTP users should be directed to the opentripplanner-users list.