SantosCloud is an API that allows users to perform analysis on videos of traffic intersections in order to produce safety statistics to enable infrastructure change that could save lives. SantosCloud provides an API that enables users to upload their videos, analyze it, and retrieve a safety report outlining the details of the intersection.
SantosCloud's analysis is performed by the excellent TrafficIntelligence project. Many thanks to Dr. Nicolas Saunier for his work on that project and collaboration with us on this project.
SantosCloud is developed and tested on Ubuntu. We've provided a helpful and easy-to-install virtual machine setup, so that SantosCloud can be run and developed on any operating system.
There are two options:
For installation of the complete environment that you will need to run SantosCloud, see the instructions in the README of the SantosInstallation repository. Those instructions will guide you on using vagrant to create a virtual machine that already contains everything you need to run SantosCloud.
As of now, instructions for local installation are still a work-in-progress. Basically, you will need to clone this repository onto your computer and install TrafficIntelligence. We are in the process of providing clean installation instructions for TrafficIntelligence.
Either way that you install SantosCloud and TrafficIntelligence, you will have to perform some steps to set up the environment for running the server.
To use the project, you must add the SantosCloud folder to your PYTHONPATH environment variable. On Ubuntu, this means adding the following line to your .bashrc:
export PYTHONPATH="${PYTHONPATH}:/home/$USER/Documents/SantosCloud"
(This example is if your SantosCloud repo lives in ~/Documents/)
A simple way to do this is by using vim ~/.bashrc or nano ~/.bashrc and then running source ~/.bashrc or restarting your terminal.
You need also set environment variables for the secret key, and you can optionally set environment variables for the server to email users on long-running analysis tasks.
You can generate a secret key by running the following python commands:
import os
os.urandom(24).encode('hex')
Add the following line to your .bashrc to set the secret key (this is required). Paste the secret key from the step above.
export SANTOSCLOUD_SECRET_KEY="ExampleSecretKey"
Add the following to your .bashrc to set the variables the server needs for email capabilities (this is optional):
export SANTOSCLOUD_EMAIL="[email protected]"
export SANTOSCLOUD_EMAIL_PASSWORD="ExamplePassword"
The email feature has only been tested with Gmail emails. If you install this locally, you can create a Gmail or use yours to send emails from when the analysis completes.
To run the server, either 1) run python app/app.py from the SantosCloud folder, or 2) cd into the app/ folder and run python app.py. This will start the server.
SantosCloud uses apidoc to automatically generate documentation for our API. In order to update this documentation, you must install apidoc.
To install apidoc in order to update the documentation, you must install npm. To install npm on Ubuntu/Debian systems, follow these steps:
- Run
curl -sL https://deb.nodesource.com/setup_4.x | sudo bash -(install curl withsudo apt-get install curlif needed) - Run
sudo apt-get install -y nodejsandsudo apt-get install -y build-essential. - Run
npm -vin a shell and ensure that npm's version is greater than 2.1.17. - If npm is out of date run
sudo npm install -g npm - Run
sudo npm install apidoc -g.
To regenerate the API Documentation, please run the following command from the SantosCloud folder:
apidoc -f ".*\\.py$" apidoc -i app/handlers/ -o app/static/apidoc
Navigate to the IP of the server and the path /static/apidoc/index.html. (For example, localhost:8888/static/apidoc/index.html).