Merge fasttrips branch into master

.gitignore

@@ -52,3 +52,10 @@ coverage.xml
 # Sphinx documentation
 docs/_build/
 
+# outputs from test network builds
+unittests/test_cube_to_fasttrips_output/*
+
+# cube log and proj files
+TPPL*.PRN
+TPPL.VAR
+TPPL.PRJ

README.md

@@ -1,15 +1,10 @@
 NetworkWrangler
 ===============
 
-NetworkWrangler is a python library that enables users to define roadway
-and transit projects as collection of data files in a local git repository,
-and then create networks by starting with a base network and applying a
-set of projects to that base network.
-
-The base network and resulting network are in the Citilabs Cube format (http://www.citilabs.com/software/cube/)
+**version**: 2.1  
+**updated**: 14 June 2018  
+**authors**:
 
-Contributors
-=======
 NetworkWrangler is the brainchild of Billy Charlton, who was the Deputy Director for Technology Services at SFCTA through 2011.
 Contributors include:
 * Elizabeth Sall, 2010-2014
@@ -18,13 +13,31 @@ Contributors include:
 * Drew Cooper, 2013-Present
 * Bhargava Sana, 2015-Present
 
+NetworkWrangler is licensed under [BSD (3-clause version)](https://github.com/sfcta/NetworkWrangler/LICENSE)
+
+NetworkWrangler has two primary functions: 
+1. Create Citilabs Cube networks for SF-CHAMP
+2. Create GTFS-PLUS networks for Fast-Trips
+
+## Creating Cube Networks for SF-CHAMP
+NetworkWrangler is a python library that enables users to define roadway
+and transit projects as collection of data files in a local git repository,
+and then create networks by starting with a base network and applying a
+set of projects to that base network.
+
+The base network and resulting network are in the [Citilabs Cube](http://www.citilabs.com/software/cube/) format 
+
+## Creating GTFS-PLUS networks for Fast-Trips
+NetworkWrangler is also a library that takes Cube networks prepared for SF-CHAMP,
+along with various other (optional) inputs, and creates networks in [GTFS-PLUS](https://github.com/osplanning-data-standards/GTFS-PLUS), a [GTFS](https://developers.google.com/transit/gtfs/reference)-based network format developed for use with [Fast-Trips](https://github.com/BayAreaMetro/fast-trips), a dynamic transit 
+passenger assignment model.  
+
 Usage
 =======
-
+## Building Cube Networks for SF-CHAMP
 Build a network by running the `build_network.py` script  in the `/scripts` folder.
 
-   python build_network.py [-c configword] [-m test] network_specification.py
-
+	python build_network.py [-c configword] [-m test] network_specification.py
 
 This will build a network using the specifications in `network_specification.py`, which should define the variables listed below (in this script)
 
@@ -34,4 +47,24 @@ If test mode is specified (with -m test), then the following happen:
   * TAG is not used for TEST_PROJECTS
 
 The [-c configword] is if you want an optional word for your network_specification.py
-  (e.g. to have multiple scenarios in one file).  Access it via CONFIG_WORD.
+  (e.g. to have multiple scenarios in one file).  Access it via CONFIG_WORD.
+
+## Building GTFS-PLUS Networks for Fast-Trips
+Build a GTFS-PLUS from the SFCTA's SF-CHAMP model inputs by running the `convert_cube_to_fasttrips.py` script in the `/scripts` folder.
+
+	python NetworkWrangler\scripts\convert_cube_to_fasttrips.py NetworkWrangler\config\config_testnet.py
+
+NOTE: This is still under development. If you have comments
+or suggestions please file them in the [issue tracker][issues]. If you have
+explicit changes please fork the [git repo][repo] and submit a pull request.
+
+After script has run:
+
+  * Add dwell time formula in vehicles_ft.txt (see network 1.12_fare)
+  * Change the "transfer" field values for sf_muni_express_bus_allday, sf_muni_light_rail_allday, sf_muni_local_bus_allday to 2 in fare_attributes_ft.txt
+  * Change the "mode" for ace_ACE_ from "inter_regional_rail" to "commuter_rail" in routes_ft.txt
+  * Replace zones_ft.txt with the version with non-zero zone_lon and zone_lat values (see network 1.12_fare)
+
+### Changelog
+2.1 Adds ability to build GTFS-PLUS networks.  
+2.0 Made NetworkWrangler compatible with SF-CHAMP 5.0.