Veloroute is a tool that allows city enthusiasts to evaluate potential bike route alternatives. Veloroute aggregates data regarding distance, elevation, speed limits and required traffic crossings, from OpenStreetMap and the City of San Francisco. Users are able to score routes by weighting variables according to their personal perception of importance. Additionally, users can visualize route-specific elevation data.
__Backend__: Python, Flask, SQLAlchemy, SQLite Techonology Stack
__Testing__: Jasmine unit tests
__APIs__: Mapbox Directions, Mapbox Surface
Clone or fork this repo:
Create and activate a virtual environment inside your project directory:
virtualenv env source env/bin/activate
Install the requirements:
pip install -r requirements.txt
Run the app:
localhost:5000/ to draw your own bike routes!
server.py : flask app
model.py : sql database which stores user data
apiModel.js : makes API requests to Mapbox
calculations.js : calculates route-specific data based on request responses
definitions.js : defines global variables and class constructors
displaydata.js : populates data tables
functionality.js : controls map capabilities including starting routes, ending routes and adding markers
pageActions.js : defines jquery functions and button events
calc-specs.js : outlines tests to be run in jasmine
## Data Decisions
- __Distance__ : total distance is measured in meters. Once a user has completed a route for analysis, an API request is sent to Mapbox's directions API which includes the origin, destination and user-selected waypoints. This request returns total distance. Raw Data
Directness of route : directness of route is calculated by taking the ratio of the total distance of the proposed route and the most direct distance between origin and destination (this distance is calculated by passing the origin and destination in Mapbox's directions API). This variable is included because bike routes should be as direct as possible as riders are less likely to use routes which are out of the way.
Traffic Crossings :the number of left turns along a route between origin and destination is used to approximate the number of difficult traffic crossings. This number is calculated by iterating over the directions returned from the Mapbox directions API and counting when the required direction is a left turn. This variable is included because left turns are particularly challenging on a bike as it requires crossing a number of lanes of traffic. As such, the number of left turns should be minimized.
Elevation Gain & Loss: elevation is measured in meters. Elevation data comes from the Mapbox surface API. Elevation is measured at frequent points along the proposed route.
Average Speed Limit : speed limit data comes from the city of san francisco. Using Mapbox's surface API, I was able to upload speed limit data to Mapbox's platform and run data requests. It is safer for people to bicycle on roads with a lower speed limit and thus, roads with lower speed limits should be prioritized. The average speed limit along a route is calculated by requesting the speed limit at frequent intervals along a route and then calculating the average from that investigation. As this is a messy dataset, I made a number of assumptions regarding the data: streets that reported speeds less than 25 mph were assumed to be 25 mph (the san francisco standard for residential streets). Additionally, along route segments without speed limits (for example pedestrian paths) the speed limit was approximated at 10 mph. Speed limit data only exists within the city of san francisco.
Standardized routes are given a score out of 100. Each variable is initaitely scored out of 25 points but can be adjusted according to a user's weight preferences. Variables are consistent with raw data except elevation is condensed into a single variable which represents the total net elevation change. Scores were assigned to variables according to my best judgement and can be updated in my code in definitions.Js. Standardized data cutoffs are as follows: Standardized Data
|Variable||5 points||10 points||15 points||20 points||25 points|
|Directness (%)||67 - 71||71 - 77||77 - 83||83 - 91||91 - 100|
|Crossings (#)||> 10||6-10||3-6||1-3||0|
|Elevation (meters)||> 200||150 - 200||100 - 150||50 - 100||< 50|
|Average Speed (mph)||> 29||27 - 29||25 - 27||20 - 25||< 20|
Elevation data is charted using the C3 library. The chart displays the change in elevation from origin to destination along a proposed route regardless of total distance.
Copyright (c) 2015 Sarah Bindman
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.