Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 2.48 KB

contributing.md

File metadata and controls

41 lines (25 loc) · 2.48 KB
layout permalink
page
/contributing/

Contribute to Santos Traffic Platform

If you are interested in only using the software and not modifying the code, please see our downloads page.

Setup Guide

Front-End Development

If you are only interested in improving the front end, it is not required to install SantosCloud. A cloud instance is running and is accessible at http://server.santostraffic.com.

  1. Fork the SantosGUI repo and follow the SantosGUI installation instructions
  2. Try running the front-end
  3. When creating a new project, point to http://server.santostraffic.com.
  4. Learn more about the cloud API by reading the SantosCloud API docs.

Full-Stack Development

For running the server code locally, we setup a Vagrant box running the server.

Please see our SantosInstallation repository for instructions.

Software Architecture

SantosPlatform is built from three components working in tandem: TrafficIntelligence, SantosGUI, and SantosCloud. These components each handle a part of the work of analyzing a user’s video -- from project creation, configuration, uploading, and analyzing. The relations between these components are detailed below.

System diagram detailing relationships between TrafficIntelligence, SantosGUI, and SantosCloud

TrafficIntelligence is a computer-vision tool that tracks cars, bikes, and pedestrians. The TrafficIntellingence project is traffic analysis software created by Dr. Nicolas Saunier from the Poly-technique University of Montreal.

SantosCloud is the portion of the software system that runs TrafficIntelligence on remote servers. SantosCloud provides a web API which will perform video analysis.

SantosGUI is a front-end for users to add video data, configure mapping, and modify analysis parameters for more accurate tracking. Once the user has performed all of the necessary configuration in this user interface, their video and configuration are uploaded via SantosCloud’s API for processing. Once processing is complete, SantosGUI displays the resulting trajectory video footage and generated metrics.