Updating tutorial

.gitignore

@@ -95,3 +95,5 @@ ENV/
 # Custom for learning-traffic
 .idea/**
 Makefile
+data/
+debug/

CODEOWNERS

@@ -0,0 +1,13 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+*       @cathywu @eugenevinitsky @AboudyKreidieh @kanaadp
+
+# Order is important. The last matching pattern has the most precedence.
+# So if a pull request only touches javascript files, only these owners
+# will be requested to review.
+# *.js    @octocat @github/js
+
+# You can also use email addresses if you prefer.
+docs/* @nskh

README.md

@@ -1,6 +1,27 @@
-# flow_dev Documentation
+[![Docs](https://readthedocs.org/projects/berkeleyflow/badge)](http://berkeleyflow.readthedocs.org/en/latest/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cathywu/flow/blob/master/LICENSE.md)
 
-## Getting Started
+# Flow
+
+Flow is a a computational framework for deep RL and control experiments for traffic microsimulation.
+
+
+# Documentation
+
+Documentation is available online: [https://berkeleyflow.readthedocs.org/en/latest/](https://berkeleyflow.readthedocs.org/en/latest/).
+
+# Citing Flow
+
+If you use Flow for academic research, you are highly encouraged to cite our upcoming journal paper:
+
+<!-- - Yan Duan, Xi Chen, Rein Houthooft, John Schulman, Pieter Abbeel. "[Benchmarking Deep Reinforcement Learning for Continuous Control](http://arxiv.org/abs/1604.06778)". _Proceedings of the 33rd International Conference on Machine Learning (ICML), 2016._ -->
+
+# Credits
+
+Flow was originally developed by members of [Professor Alexandre Bayen](http://bayen.eecs.berkeley.edu/)'s lab at UC Berkeley: Cathy Wu, Eugene Vinitsky, Kanaad Parvate, Aboudy Kreidieh, Nishant Kheterpal, Leah Dickstein, Nathan Mandi, Kathy Jang, and Ananth Kuchibhotla. Development on the framework continues by people at UC Berkeley.
+
+
+<!-- ## Getting Started
 
 - TODO: Tutorial for visualization / plot generating scripts
 
@@ -89,10 +110,10 @@ Development
   from the project root directory:
 
       ln -s ../../pre-commit.sh .git/hooks/pre-commit
-      
+
 Warnings:
 ====
-All car controllers come equipped with a fail-safe rule wherein cars are not allowed to 
-move at a speed that would cause them to crash if the car in front of them suddenly started 
-breaking with max acceleration. If they attempt to do so, they will be reset to move at $$v_safe$$ 
-where $$v_safe$$ is the speed such that the cars will come to rest at the same point. 
+All car controllers come equipped with a fail-safe rule wherein cars are not allowed to
+move at a speed that would cause them to crash if the car in front of them suddenly started
+breaking with max acceleration. If they attempt to do so, they will be reset to move at $$v_safe$$
+where $$v_safe$$ is the speed such that the cars will come to rest at the same point.  -->

docs/source/conf.py

@@ -17,9 +17,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../flow'))
 
 
 # -- General configuration ------------------------------------------------
@@ -31,7 +31,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.imgmath']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.imgmath', 
+              'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+napoleon_google_docstring = False
+napoleon_use_param = False
+napoleon_use_ivar = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -46,7 +50,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'flow'
+project = 'Flow'
 copyright = '2017, Cathy Wu'
 author = 'Cathy Wu'
 

docs/source/flow.controllers.rst

@@ -0,0 +1,70 @@
+flow\.controllers package
+=========================
+
+Submodules
+----------
+
+flow\.controllers\.base\_controller module
+------------------------------------------
+
+.. automodule:: flow.controllers.base_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.base\_lane\_changing\_controller module
+----------------------------------------------------------
+
+.. automodule:: flow.controllers.base_lane_changing_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.base\_routing\_controller module
+---------------------------------------------------
+
+.. automodule:: flow.controllers.base_routing_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.car\_following\_models module
+------------------------------------------------
+
+.. automodule:: flow.controllers.car_following_models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.lane\_change\_controllers module
+---------------------------------------------------
+
+.. automodule:: flow.controllers.lane_change_controllers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.rlcontroller module
+--------------------------------------
+
+.. automodule:: flow.controllers.rlcontroller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.controllers\.routing\_controllers module
+----------------------------------------------
+
+.. automodule:: flow.controllers.routing_controllers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: flow.controllers
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/flow.core.rst

@@ -0,0 +1,86 @@
+flow\.core package
+==================
+
+Submodules
+----------
+
+flow\.core\.config module
+-------------------------
+
+.. automodule:: flow.core.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.config\.template module
+-----------------------------------
+
+.. automodule:: flow.core.config.template
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.experiment module
+-----------------------------
+
+.. automodule:: flow.core.experiment
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.generator module
+----------------------------
+
+.. automodule:: flow.core.generator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.multi\_agent\_rewards module
+----------------------------------------
+
+.. automodule:: flow.core.multi_agent_rewards
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.params module
+-------------------------
+
+.. automodule:: flow.core.params
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.rewards module
+--------------------------
+
+.. automodule:: flow.core.rewards
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.util module
+-----------------------
+
+.. automodule:: flow.core.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.core\.vehicles module
+---------------------------
+
+.. automodule:: flow.core.vehicles
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: flow.core
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/flow.envs.rst

@@ -0,0 +1,78 @@
+flow\.envs package
+==================
+
+Submodules
+----------
+
+flow\.envs\.base\_env module
+----------------------------
+
+.. automodule:: flow.envs.base_env
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.intersection\_env module
+------------------------------------
+
+.. automodule:: flow.envs.intersection_env
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.lane\_changing module
+---------------------------------
+
+.. automodule:: flow.envs.lane_changing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.loop\_accel module
+------------------------------
+
+.. automodule:: flow.envs.loop_accel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.loop\_merges module
+-------------------------------
+
+.. automodule:: flow.envs.loop_merges
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.loop\_with\_perturbation module
+-------------------------------------------
+
+.. automodule:: flow.envs.loop_with_perturbation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.two\_intersection module
+------------------------------------
+
+.. automodule:: flow.envs.two_intersection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.envs\.two\_loops\_one\_merging module
+-------------------------------------------
+
+.. automodule:: flow.envs.two_loops_one_merging
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: flow.envs
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/flow.rst

@@ -0,0 +1,48 @@
+Flow package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    flow.controllers
+    flow.core
+    flow.envs
+    flow.scenarios
+
+Submodules
+----------
+
+flow\.visualizer\_CISTAR module
+-------------------------------
+
+.. automodule:: flow.visualizer_CISTAR
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.visualizer\_CISTAR\_multiagent module
+-------------------------------------------
+
+.. automodule:: flow.visualizer_CISTAR_multiagent
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+flow\.visualizer\_CISTAR\_tf module
+-----------------------------------
+
+.. automodule:: flow.visualizer_CISTAR_tf
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: flow
+    :members:
+    :undoc-members:
+    :show-inheritance: