search

opentripplanner / OpenTripPlanner

An open source multi-modal trip planner
http://www.opentripplanner.org
Other
2.21k stars 1.03k forks source link

Improve graph builder documentation #280

Closed novalis closed 13 years ago

novalis commented 13 years ago

Not all converters and options are fully documented and many don't have example usage.

I've started updating the GraphBuilder wiki page with new documentation. My guess is we'll probably want to break that into multiple pages since it's already starting to grow unwieldy.

We also need Javadoc for much of the actual code here.

novalis commented 13 years ago

(In [834]) Updates #280 (improve graph builder documentation)

--nicholasbs

novalis commented 13 years ago

(In [835]) Updates #280 (improve graph builder docs)

--nicholasbs

novalis commented 13 years ago

(In [836]) try to improve formatting (updates #280)

--nicholasbs

novalis commented 13 years ago

(In [837]) tweak formatting some more (updates #280)

--nicholasbs

novalis commented 13 years ago

(In [838]) Continue improving graph builder documentation (updates #280)

--nicholasbs

novalis commented 13 years ago

We really need a kick-ass set of OSM configurations that build optimum transit/walking/biking/auto/(combo of all) graphs. My OSM graph is built using that from http://opentripplanner.org/wiki/GraphBuilder, and I can tell that the biking instructions are simply bogus (eg: routing goes over the Ross Island bridge, which is a big no-no).

--fpurcell

novalis commented 13 years ago

So, is this bug now "OSM configurations stink"?

--novalis

novalis commented 13 years ago

Thinking about it, I'm not sure that OSM knows anything about bike lanes. That's probably part of the problem. I didn't write most of the OSM code -- I think it was largely Flaktack. Would you be interested in messing with this code? I can merge anything you change up to the branch (or you can wait until it lands).

source:trunk/opentripplanner-graph-builder/src/main/java/org/opentripplanner/graph_builder/impl/osm/OpenStreetMapGraphBuilderImpl.java

--novalis

novalis commented 13 years ago

Nope, not asking to redefine the bug...still want it to be "Improve graph builder documentation" (as opposed to "OSM configurations stink"). Improved documentation would hopefully include example configuration files that show how best to configure OTP's graph builder, and since both bikes and OSM are major aspects of OTP, having a detailed & descriptive configuration would help.

If I were to ask to redefine the ticket, I might be inclined to rename it to "Improve graph builder interface to make it usable by humans", but we have tickets like #160 and #254 which speak to that need.

BTW, there is some bike lane info in OSM (and data available for Portland, among other places): http://wiki.openstreetmap.org/wiki/Cycle_routes http://www.opencyclemap.org/?zoom=15&lat=45.51587&lon=-122.66124&layers=B000

--fpurcell

novalis commented 13 years ago

See ticket #106 (not 160).

--fpurcell

novalis commented 13 years ago

I've updated the graph builder documentation to put some general concepts first, and to address the bicycling issue in OSM. Please let me know what you think.

--novalis

novalis commented 13 years ago

I think the graph builder docs are quite nice now.

--novalis