Added examples page to docs and updated the project-level README

Author: kaeldai

README.md

@@ -18,6 +18,14 @@ base requirements from a command-line:
 
 There are examples of building models and running simulations located in docs/examples/. Some of the simulation engines may require additonal requirements to run.
 
+##### Tests
+
+There are a collection of unit-tests in ```bmtk.tests``` which can be run using pytest
+
+```bash
+  $ cd bmtk
+  $ py.test
+```
 
 ## Documentation
 

docs/autodocs/source/examples.rst

@@ -0,0 +1,35 @@
+Example Networks and Simulations
+================================
+
+
+Mouse V1 Layer 4 Model
+-----------------------
+
+A ~45,000 cell model of the primary input layer (L4) of the mouse primary visual cortex. Built using BMTK and simulated
+using BioNet:
+
+https://portal.brain-map.org/explore/models/l4-mv1
+
+
+Mouse V1 Full Column Models
+---------------------------
+
+Biologically realistic models of the mouse primary visual cortex (V1) with ~230,000 simulated neurons. Contains two
+different types of models: A multi-compartmental model using BioNet and a GLIF-based point-neuron model using
+PointNet.
+
+
+https://portal.brain-map.org/explore/models/mv1-all-layers
+
+
+Brunel Models
+-------------
+
+12,500 neuron models based on the network described in "Dynamics of Sparsely Connected Networks of Excitatory and
+Inhibitory Spiking Neurons", Nicolas Brunel, 2000. The models are built using BioNet, PointNet, and PopNet and
+is a good metric of how to compare simulations ran across different levels of resultion:
+
+
+https://github.com/AllenInstitute/bmtk/tree/develop/docs/examples/ei_network
+
+

docs/autodocs/source/index.rst

@@ -17,6 +17,7 @@ Welcome to the Brain Modeling Toolkit
    simulators
    analyzer
    tutorials
+   Example Networks <examples>
    Github Profile <https://github.com/AllenInstitute/bmtk.git>
    contributors
    Source Documentation <bmtk/bmtk>