.. TrafficSense documentation master file, created by sphinx-quickstart on Mon Oct 30 13:38:06 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to TrafficSense's documentation! ======================================== The TrafficSense project was started as part of the Rochester Institute of Technology Multidisciplinary Senior Design program. The TrafficSense tools are designed to facilitate simple use of the SUMO traffic simulation software so the user can focus on optimizing traffic light controls at an intersection. The project aims to make it easier to make intersections better. The original team behind this project has graduated. Please contact Dr. Katie McConky at RIT if you need anything. .. toctree:: :maxdepth: 5 :caption: Contents: Installation ------------ Be sure to install ``git`` and have a dedicated Python 3.5+ environment handy. We recommend Anaconda. ``git clone https://github.com/TrafficSenseMSD/core.git`` ``cd core`` ``pip install .`` ``ts_config`` Documentation --------------------------- Getting started with SUMO requires the definition of intersection geometery and traffic demand. If you need a first step, this is the droid you're looking for. A template for intersection configuration can be found in ``ts_core/config/``. YOU WILL NEED THIS! :ref:`ts_config_cli` Source code docs are written using the Numpydocs format in the code. Additional docs are written in ReStructuredtext format. Here's a primer on ReStructuredText syntax. http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html ``ts_runner`` Documentation --------------------------- :ref:`ts_runner_cli` Project Developer Documentation ------------------------------- ``ts_runner`` ~~~~~~~~~~~~~ :ref:`ts_runner_rolodex` :ref:`ts_runner_variable` ``ts_config`` ~~~~~~~~~~~~~ :ref:`ts_config_bindings` :ref:`ts_config_parser`: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`