Skip to content
Sawyer Vaughan edited this page Apr 18, 2017 · 11 revisions

Welcome to the Wiki for SantosGUI!

SantosGUI is a part of the SantosPlatform, a software system that analyzes intersection video to produce traffic safety metrics. SantosGUI interfaces with SantosCloud to perform the analysis.

See our System Architecture page for more information about the working of the entire system, or the Application Architecture page for more information about SantosGUI's structure.

Developing for SantosGUI

To develop for SantosGUI, install SantosGUI using our installation instructions. Then review our contribution guide below, and begin working on an issue or future work.

If you're just getting started and would like an overview of how the application is laid out and where to change, see our application architecture page.

Contribution Guide

Our project is maintained using the fork and pull request workflow. To contribute to our project, please fork our repository, do your work on a branch of your forked repository, and create a pull request when you are done.

Running the project.

See Running the Project for information on running the project. To run the project, you must have the IP address for an instance of the SantosCloud server.

SantosCloud Instance

SantosGUI requires an instance of our server application to perform the analysis on a video. For a list of currently running servers to use, look at the list of currently running SantosCloud servers. When creating a project in SantosGUI, you must specify this server.

Using SantosGUI without Developing

To use SantosGUI without having to perform the longer installation instructions, you can download an executable that is linked to on our downloads page.