Skip to content

Commit

Permalink
update docs to refer to Conveyal Maven repo
Browse files Browse the repository at this point in the history
I have added directory listings to that server, and we are shutting down our Jenkins server since we're now using Travis CI
  • Loading branch information
abyrd committed Oct 29, 2015
1 parent fe641cc commit 140cab6
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 33 deletions.
13 changes: 4 additions & 9 deletions docs/Basic-Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@ This page will get you up and running with your own OTP server. If all goes well

## Get OTP

OpenTripPlanner is written in Java and distributed as a single runnable JAR file. These JARs are published
[here](http://dev.opentripplanner.org/jars/). Grab one of these JARs for the
[latest released version](http://dev.opentripplanner.org/jars/otp-0.18.0-shaded.jar)
or if you're feeling adventurous try the
[bleeding edge development code](http://dev.opentripplanner.org/jars/otp-0.19.0-SNAPSHOT-shaded.jar).
You may also want to get your own copy of the OTP source code and [build the JAR from scratch](Getting-OTP),
especially if you plan to do some development yourself.
OpenTripPlanner is written in Java and distributed as a single runnable JAR file. These JARs are published on the Conveyal Maven repository [here](http://maven.conveyal.com/org/opentripplanner/otp/). Grab one of these JARs for the [latest released version 0.19](http://maven.conveyal.com.s3.amazonaws.com/org/opentripplanner/otp/0.19.0/otp-0.19.0-shaded.jar)
You may also want to get your own copy of the OTP source code and [build a bleeding edge development JAR from scratch](Getting-OTP), especially if you plan to do some development yourself.

## Get some data

Expand Down Expand Up @@ -59,15 +54,15 @@ If you do not you will need to install a recent OpenJDK or Oracle Java package f

GTFS and OSM data sets are often very large, and OTP is relatively memory-hungry. You will need at least 1GB of memory
when working with the Portland TriMet data set, and several gigabytes for larger inputs. A typical command to start OTP
looks like `java -Xmx1G -jar otp-0.18.0-shaded.jar <options>`. The `-Xmx` parameter sets
looks like `java -Xmx1G -jar otp-0.19.0-shaded.jar <options>`. The `-Xmx` parameter sets
the limit on how much memory OTP is allowed to consume. If you have sufficient memory in your computer,
set this to a couple of gigabytes; when OTP doesn't have enough "breathing room" it can grind to a halt.

It's possible to analyze the GTFS, OSM and any other input data and save the resulting representation of the transit
network (what we call a ['graph'](http://en.wikipedia.org/wiki/Graph_%28mathematics%29)) to disk.
For simplicity we'll skip saving this file and start up an OTP server immediately after the graph is built. The command to do so is:

java -Xmx2G -jar otp-0.18.0-shaded.jar --build /home/username/otp --inMemory
java -Xmx2G -jar otp-0.19.0-shaded.jar --build /home/username/otp --inMemory

where `/home/username/otp` should be the directory where you put your input files. The graph build operation should
take about one minute to complete, and then you'll see a `Grizzly server running` message. At this point you can open
Expand Down
16 changes: 5 additions & 11 deletions docs/Getting-OTP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Pre-built JARs

OpenTripPlanner is now distributed as a single stand-alone runnable JAR file. The JAR file for each release is
published [here](http://dev.opentripplanner.org/jars/).
OpenTripPlanner is now distributed as a single stand-alone runnable JAR file. The JAR files for each release are
published to the [Conveyal Maven repository](http://maven.conveyal.com/org/opentripplanner/otp/). Most users will want to navigate into the directory with the highest-numbered non-snapshot version and download the file whose name ends with `shaded.jar`. The latest release is the [0.19.0 shaded JAR](http://maven.conveyal.com.s3.amazonaws.com/org/opentripplanner/otp/0.19.0/otp-0.19.0-shaded.jar).

## Building from Source

Expand All @@ -17,7 +17,6 @@ You may also choose to build OTP from its source code. If you will be modifying

- Maven, a build and dependency management system


You will also need a reliable internet connection so Maven can fetch all of OTP's dependencies (the libraries it uses).
To install these software packages on a Debian or Ubuntu system, run:

Expand Down Expand Up @@ -90,9 +89,8 @@ all the external libraries that OTP uses, runs all the commands to compile the O
performs tests, and can then deploy the final "artifact" (the runnable JAR file) to our Maven repository, from which it
can be automatically included in other Java projects.

This repository is machine-readable (by Maven or other build systems) and for the moment does not include any human readable indexes.
You can nonetheless fetch an OTP JAR from this repository by constructing the proper URL for the release
you want. For example, release 0.13.0 will be found at `http://maven.conveyal.com/org/opentripplanner/otp/0.13.0/otp-0.13.0-shaded.jar`.
This repository is machine-readable (by Maven or other build systems) and also provides decent human readable listings via HTTP. You can fetch an OTP JAR from this repository by constructing the proper URL for the release
you want. For example, release 0.19.0 will be found at `http://maven.conveyal.com/org/opentripplanner/otp/0.19.0/otp-0.19.0-shaded.jar`.

To make use of OTP in another project, you must first specify our Maven repository in the Project Object Model (POM):

Expand All @@ -112,7 +110,7 @@ And then specify OpenTripPlanner as a dependency:
<dependency>
<groupId>org.opentripplanner</groupId>
<artifactId>otp</artifactId>
<version>0.18.0</version>
<version>0.19.0</version>
</dependency>
```

Expand All @@ -127,7 +125,3 @@ always fetch the latest work in progress by specifying a snapshot artifact:
<version>0.19.0-SNAPSHOT</version>
</dependency>
```

We may eventually migrate to the Gradle build system, but Gradle uses the same dependency management and
repository system as Maven.

11 changes: 1 addition & 10 deletions docs/Version-Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,11 @@ It has already shifted toward the 1.0 API in that router IDs are systematically
coherent hierarchical structure.

#### Standalone deployment
Running `otp-core/target/otp.jar` (which contains all dependencies) you will find:
Running `otp-core/target/otp-x.y.z-shaded.jar` (which contains all dependencies) you will find:
- API base path [[http://localhost:8080/otp/]]
- Trip planner endpoint [[http://localhost:8080/otp/routers/default/plan?...]]
- The GTFS index (agencies, stops, etc.) [[http://localhost:8080/otp/routers/default/transit/agencyIds]]

#### Servlet container deployment
You can also deploy `otp-core/target/otp.war` (the core API server, including dependencies) and typically `otp-leaflet-client/target/otp-leaflet-client.war` (the Javascript map-based trip planning UI) to a Java application server such as Tomcat. Due to the fact that servlet containers will typically expose the services provided by a WAR file at a context path equal to the name of the WAR file, the API base path will probably be different when you use a servlet container.

- API base path is [[http://localhost:8080/opentripplanner-api-webapp/ws/]]
- The GTFS index (agencies, stops, etc.) [[http://localhost:8080/opentripplanner-api-webapp/ws/routers/default/transit/agencyIds]]

For detailed paths of specific resources under these base paths, see the API docs at [[http://docs.opentripplanner.org/apidoc/0.11.0/]]


## Version 0.10 (branch 0.10.x)
This is the maintenance branch for release opentripplanner-0.10.0, which contains very few updates since early 2013. It uses a version of the API that is fast disappearing, and exists mainly for those who wish to avoid changing interfaces in long-standing deployments (e.g. router IDs are provided as query parameters). It only allows deployment to a servlet container and does not contain its own HTTP layer. We recommend against using this branch if you are new to OTP.

Expand Down
5 changes: 2 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
## OpenTripPlanner
_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**](http://www.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](http://www.gnu.org/licenses/lgpl-3.0.txt) license.
The code is under active development with a variety of [deployments](Deployments) around the world, and we are working toward a 1.0 release in the coming year.
**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](http://www.gnu.org/licenses/lgpl-3.0.txt) license. The code is under active development with a variety of [deployments](Deployments) around the world, and we are working toward a 1.0 release for the end of 2015.

If you want to get started right away running your own OTP instance, the best place to start is the [Basic Usage](Basic-Usage) page.

Expand All @@ -28,7 +27,7 @@ If you want to get started right away running your own OTP instance, the best pl

[![Build Status](https://travis-ci.org/opentripplanner/OpenTripPlanner.svg?branch=master)](https://travis-ci.org/opentripplanner/OpenTripPlanner)

OpenTripPlanner is presently at **version 0.18.0**. See the [changelog](Changelog) and the [version notes](Version-Notes) to decide which branch or tag you want to work with. The software currently:
OpenTripPlanner is presently at **version 0.19.0**. See the [changelog](Changelog) and the [version notes](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
Expand Down

0 comments on commit 140cab6

Please sign in to comment.