Skip to content

Commit

Permalink
docs: update 2.0-rc to v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
abyrd committed Nov 27, 2020
1 parent 69df678 commit d133850
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/Basic-Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ As a Java program, OTP must be run within a Java virtual machine (JVM), which is

OpenTripPlanner is written in Java and distributed as a single runnable JAR file. This is a "shaded" JAR containing all other libraries needed for OTP to work. The OTP2 release candidate is available from the Maven Central repository. You will be able to go to [the OTP directory at Maven Central](https://repo1.maven.org/maven2/org/opentripplanner/otp/), navigate to the [directory for the release candidate](https://repo1.maven.org/maven2/org/opentripplanner/otp/2.0.0-rc1/), and download the [file whose name ends with `shaded.jar`](https://repo1.maven.org/maven2/org/opentripplanner/otp/2.0.0-rc1/otp-2.0.0-rc1-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.md), especially if you plan to do some development yourself. Currently the OTP2 release candidate is in feature freeze, meaning we are not adding any new features, only stabilizing the existing ones for release. So if you want to test and fix existing functionality for the release, check out the branch `2.0-rc`; if you want to work on new features that will be contributed after the 2.0 releaes, be sure to check out the `dev-2.x` branch before running the build.
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.md), especially if you plan to do some development yourself. Currently the OTP2 release candidate is in feature freeze, meaning we are not adding any new features, only stabilizing the existing ones for release. So if you want to test and fix existing functionality for the release, check out the branch `dev-2.x`.

## Get some data

Expand Down
14 changes: 7 additions & 7 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Using the file `otp-config.json` you can enable or disable different APIs and ex
sandbox features are disabled. So for most OTP2 use cases it is not necessary to create this file.
Features that can be toggled in this file are generally only affect the routing phase of OTP2
usage, but for consistency all such "feature flags", even those that would affect graph building,
are managed in this one file. See the [OTPFeature](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/util/OTPFeature.java)
are managed in this one file. See the [OTPFeature](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/util/OTPFeature.java)
Java class for an enumeration of all available features and their default settings. Here is an
example:

Expand Down Expand Up @@ -121,7 +121,7 @@ config key | description | value type | value default | notes
`useTransfersTxt` | Create direct transfer edges from transfers.txt in GTFS, instead of based on distance | boolean | false |
`writeCachedElevations` | If true, writes the calculated elevation data. | boolean | false | see [Elevation Data Calculation Optimizations](#elevation-data-calculation-optimizations)

This list of parameters in defined in the [BuildConfig.java](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/standalone/config/BuildConfig.java).
This list of parameters in defined in the [BuildConfig.java](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/standalone/config/BuildConfig.java).


## Storage
Expand Down Expand Up @@ -164,7 +164,7 @@ Note that when files are specified with URIs in this configuration, the file typ

The default behavior of scanning the base directory for inputs is overridden independently for each file type. So in the above configuration, GTFS and OSM will be loaded from Google Cloud Storage, but OTP2 will still scan the base directory for all other types such as DEM files. Supplying an empty array for a particular file type will ensure that no inputs of that type are loaded, including by local directory scanning.

See the comments in the source code of class [StorageConfig.java](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/standalone/config/StorageConfig.java)
See the comments in the source code of class [StorageConfig.java](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/standalone/config/StorageConfig.java)
for an up-to-date detailed description of each config parameter.

### Local Filename Patterns
Expand Down Expand Up @@ -306,7 +306,7 @@ OTP allows you to adjust the elevation values reported in API responses in two w
The first way is to store ellipsoid (GPS) elevation values internally, but apply a single geoid
difference value in the OTP client where appropriate to display elevations above sea level.
This ellipsoid to geoid difference is returned in each trip plan response in the
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java) field.
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java) field.
Using a single value can be sufficient for smaller OTP deployments, but might result in incorrect
values at the edges of larger OTP deployments. If your OTP instance uses this, it is recommended
to set a default request value in the `router-config.json` file as follows:
Expand Down Expand Up @@ -537,7 +537,7 @@ There are many trip planning options used in the OTP web API, and more exist
internally that are not exposed via the API. You may want to change the default value for some of these parameters,
i.e. the value which will be applied unless it is overridden in a web API request.

A full list of them can be found in the [RoutingRequest](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/routing/api/request/RoutingRequest.java).
A full list of them can be found in the [RoutingRequest](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/routing/api/request/RoutingRequest.java).
Any public field or setter method in this class can be given a default value using the routingDefaults section of
`router-config.json` as follows:

Expand Down Expand Up @@ -675,7 +675,7 @@ config key | description | value type | value default
`iterationDepartureStepInSeconds` | Step for departure times between each RangeRaptor iterations. A transit network usually uses minute resolution for its depature and arrival times. To match that, set this variable to 60 seconds. | int | `60`
`searchThreadPoolSize` | Split a travel search in smaller jobs and run them in parallel to improve performance. Use this parameter to set the total number of executable threads available across all searches. Multiple searches can run in parallel - this parameter have no effect with regard to that. If 0, no extra threads are started and the search is done in one thread. | int | `0`
`dynamicSearchWindow` | The dynamic search window coefficients used to calculate the EDT(earliest-departure-time), LAT(latest-arrival-time) and SW(raptor-search-window) using heuristics. | object | `null`
`stopTransferCost` | Use this to set a stop transfer cost for the given [TransferPriority](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/model/TransferPriority.java). The cost is applied to boarding and alighting at all stops. All stops have a transfer cost priority set, the default is `ALLOWED`. The `stopTransferCost` parameter is optional, but if listed all values must be set. | enum map | `null`
`stopTransferCost` | Use this to set a stop transfer cost for the given [TransferPriority](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/model/TransferPriority.java). The cost is applied to boarding and alighting at all stops. All stops have a transfer cost priority set, the default is `ALLOWED`. The `stopTransferCost` parameter is optional, but if listed all values must be set. | enum map | `null`

### Tuning transit routing - Dynamic search window
Nested inside `transit : { dynamicSearchWindow : { ... } }` in `router-config.json`.
Expand Down Expand Up @@ -908,4 +908,4 @@ To configure and url for the [BikeRentalServiceDirectory](sandbox/BikeRentalServ

# Configure using command-line arguments

Certain settings can be provided on the command line, when starting OpenTripPlanner. See the `CommandLineParameters` class for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java).
Certain settings can be provided on the command line, when starting OpenTripPlanner. See the `CommandLineParameters` class for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java).
4 changes: 2 additions & 2 deletions docs/OTP2-MigrationGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ Support for XML as a request/response format is removed. The only supported form

#### Query parameter changes

A lot of the query parameters in the REST API are ignored/deprecated, see the [RoutingRequest](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/routing/api/request/RoutingRequest.java)
and the [RoutingResource](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/api/common/RoutingResource.java)
A lot of the query parameters in the REST API are ignored/deprecated, see the [RoutingRequest](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/routing/api/request/RoutingRequest.java)
and the [RoutingResource](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/api/common/RoutingResource.java)
class for the documentation on what is now supported in 2.0. A few features did not make it into
the 2.0, but is sheduled for the 2.1 release.
See [GitHub issues 2.1](https://github.com/opentripplanner/OpenTripPlanner/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.1).
Expand Down
2 changes: 1 addition & 1 deletion docs/SandboxExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ nearby stops generated by routing via OSM data.
- Change log
- Documentation of the feature (optional)
- List your extension in the [Available extensions](#Available extensions) section and in the
[mydocs config file](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/mkdocs.yml).
[mydocs config file](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/mkdocs.yml).
- Use feature toggling to enable a feature at runtime. The feature must be disabled by default.
A feature is toggled _on_ using the config files.
- Only code modifying the main code(`src/main`, not `src/ext`) is reviewed. The current coding
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@

**OpenTripPlanner** (OTP) is an open source multi-modal trip planner, focusing on travel by scheduled public transportation in combination with bicycling, walking, and mobility services including bike share and ride hailing. Its server component runs on any platform with a Java virtual machine (including Linux, Mac, and Windows). It exposes REST and GraphQL APIs that can be accessed by various clients including open source Javascript components and native mobile applications. It builds its representation of the transportation network from open data in open standard file formats (primarily GTFS and OpenStreetMap). It applies real-time updates and alerts with immediate visibility to clients, finding itineraries that account for disruptions and service changes. OTP is released under the [LGPL license](https://opensource.org/licenses/LGPL-3.0). As of 2020, the codebase has been in active development for over ten years, and is relied upon by transportation authorities and travel planning applications in [deployments](Deployments.md) around the world.

You are currently reading the documentation for **OpenTripPlanner 2**, the second major version of OTP, which is still under development but approaching release. As of 21 September 2020 OpenTripPlanner 2 is in feature freeze, and we have published a release candidate v2.0-RC1 which is now undergoing final testing.
You are currently reading the documentation for **OpenTripPlanner 2**, the second major version of OTP.

The most recent stable release of OTP is **OpenTripPlanner 1.4**. If you do not want to test the cutting edge system, please switch to that documentation set.

# Versions of this documentation

Several versions of this documentation are built and published automatically for different branches of OTP. Each of these has a different stable URL, and you may switch between these versions using the selector in the lower right of the published documentation.

- [Latest](http://docs.opentripplanner.org/en/latest) - Latest stable release from master branch
- [v2.0.0](http://docs.opentripplanner.org/en/v2.0.0) - Most recent release 2.0
- [v1.5.0](http://docs.opentripplanner.org/en/v1.5.0) - Stable 1.x release
- [dev-1.x](http://docs.opentripplanner.org/en/dev-1.x) - OTP 1 active development
- [dev-2.x](http://docs.opentripplanner.org/en/dev-2.x) - OTP 2 active development
- [2.0-rc](http://docs.opentripplanner.org/en/2.0-rc) - OTP 2 release candidate undergoing testing

# Audience

Expand Down
2 changes: 1 addition & 1 deletion docs/sandbox/GoogleCloudStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- Initial implementation to access Google Cloud Storage (read and write). (December 2019)

## Documentation
To enable this turn on the feature `GoogleCloudStorage`. OTP can load or store artifacts from one or more Google Cloud Storge locations. Each artifact must be configured in the _build-config.json_: See [`StorageConfig`](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/main/java/org/opentripplanner/standalone/config/StorageConfig.java) on how to configure artifacts.
To enable this turn on the feature `GoogleCloudStorage`. OTP can load or store artifacts from one or more Google Cloud Storge locations. Each artifact must be configured in the _build-config.json_: See [`StorageConfig`](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/main/java/org/opentripplanner/standalone/config/StorageConfig.java) on how to configure artifacts.



Expand Down
2 changes: 1 addition & 1 deletion docs/sandbox/transferanalyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
Module used for analyzing the transfers between nearby stops generated by routing via OSM data. It generates lists of both unusually long and unroutable transfers. These lists can typically be used to improve the quality of OSM data for transfer purposes.

See javadoc in
[DirectTransferAnalyzer](https://github.com/opentripplanner/OpenTripPlanner/blob/2.0-rc/src/ext/java/org/opentripplanner/ext/transferanalyzer/DirectTransferAnalyzer.java) class
[DirectTransferAnalyzer](https://github.com/opentripplanner/OpenTripPlanner/blob/v2.0.0/src/ext/java/org/opentripplanner/ext/transferanalyzer/DirectTransferAnalyzer.java) class

0 comments on commit d133850

Please sign in to comment.