Note: this documentation is targeted primarily at the OTP development community and more technical users. For high-level information about the project, please visit opentripplanner.org
OpenTripPlanner (OTP) is an open source multi-modal trip planner, which runs on Linux, Mac, Windows, or potentially any platform with a Java virtual machine. OTP is released under the LGPL license. The code is under active development with a variety of deployments around the world.
If you want to get started right away running your own OTP instance, the best place to start is the Basic Usage page.
Latest Project Updates
After seven years of hard work, a 1.0 release is planned for August of 2016! OTP is in feature freeze, with all work concentrating on bug fixes and API cleanup.
As of 2015, OTP powers the New York State department of transportation's transit trip planner. It provides itineraries for public transit systems throughout the state in a single unified OTP instance.
In November of 2014, Arlington, Virginia launched a new commute planning site for the Washington, DC metropolitan area. It depends on OpenTripPlanner to weigh the costs and benefits of various travel options, making use of profile routing.
OpenTripPlanner was a focal point in the Dutch Transport Ministry's MMRI (MultiModal Travel Information) project which encouraged investment in trip planning platforms and services. A consortium of five companies worked together to improve OpenTripPlanner performance in large regional transport networks and account for real-time service modifications and delays. The resulting Plannerstack Foundation is now providing OpenTripPlanner and Bliksem RRRR as hosted services including high quality open data integration for the Netherlands.
OpenTripPlanner has become Software Freedom Conservancy's thirty-first member project. Conservancy is a non-profit public charity that provides a range of financial and administrative services to member projects that develop Free, Libre, and Open Source Software. By joining Conservancy, OpenTripPlanner obtains the benefits of a formal non-profit organizational structure while keeping the project focused on software development and documentation.
After seven years of hard work, a 1.0 release of OTP is planned for August of 2016! OTP is in feature freeze, with all work concentrating on bug fixes and API cleanup. See the changelog and the version notes to decide which branch or tag you want to work with. The software currently:
- Plans multi-modal walking, wheelchair, bicycle and transit trips
- Takes travel time, road type, safety, and elevation into account, and allows users to customize the weighting of these three factors
- Shows graphical elevation profiles for bike trips
- Imports data from GTFS, OpenStreetMap, and digital elevation models
- Typically provides multiple itineraries in a fraction of a second even in large metropolitan networks
- Exposes a web services API which other apps or front-ends can build on
- Supports GTFS-Realtime for service changes and alerts in both polling (pull) and streaming (push) modes
- Supports bike rental with dynamic availability information, as well as park-and-ride and kiss-and-ride
- Supports one-to-many and many-to-many searches for planning, alternatives analysis, and accessibility research purposes
See the Milestones page to explore upcoming developments.
Basic OTP Architecture
At the core of OpenTripPlanner is a library of Java code that finds efficient paths through multi-modal transportation networks built from OpenStreetMap and GTFS data. Several different services are built upon this library:
The OTP Transit Index API is another RESTful web service that provides information derived from the input GTFS feed(s). Examples include routes serving a particular stop, upcoming vehicles at a particular stop, upcoming stops on a given trip, etc.
The term "OTP Analyst" refers to parts of OTP that apply the routing engine to transportation network analysis rather than end-to-end trip planning. OTP Analyst includes:
The OTP Analyst Web Services provide network analysis results such as travel time maps and isochrones as standard web Mercator tiles or GIS rasters via a WMS-derived API. These web services are conceptually separate from the routing API, but are provided by the same servlet: once you have a working OTP trip planner you can also use it to produce travel time maps and other visualizations of transit service. See this blog post for discussion and examples.
The OTP Analyst Batch Processor is a command-line tool that handles more complex one-off network analysis tasks. It uses the same core routing library and data sources as other OTP services, but allows for very open-ended configuration and the inclusion of population or opportunity data. While configuration and use are currently somewhat opaque for non-developers, the "Batch Analyst" is becoming a powerful tool for visualizing how transportation networks affect access to urban opportunities. See this article for an example case study on the effects of hurricane Sandy in New York.
The OTP Scripting API allow the execution of routing requests from within scripts (such as Python). It is composed of a stable internal API, and an embedded Jython interpreter. It can be used in different contexts, such as batch analysis or automated regression testing. More information here.
- Basic Usage (get started quickly)
- Internationalization and Translations
- Developers Guide (code conventions, how to submit patches, etc)
Some other types of documentation are generated for OTP from its source code:
- Javadoc documentation for the entire project
- Web service API documentation (automatically generated by Enunciate)
Send questions and comments to the user mailing list. Discuss internal development details on the dev mailing list. File bug reports via the Github issue tracker. Note that the issue tracker is not intended for support questions or discussions. Please post them to one of the mailing lists instead.
The project began a collaborative effort among TriMet, OpenPlans, and the developers of FivePoints, OneBusAway and Graphserver, and has since grown to encompass a global community of users and developers. More information on OTP's origins is available at the Project History page. In November of 2013, OpenTripPlanner became the thirty-first member project of the Software Freedom Conservancy.
OpenTripPlanner is a member project of Software Freedom Conservancy, a 501(c)(3) organization incorporated in New York, and donations made to it are fully tax-deductible to the extent permitted by law. Donations can be made by credit card, wire transfer or paper check. Please contact firstname.lastname@example.org for instructions. Be sure to note in the email what country the wire transfer will initiate from and what currency it will be in.