| 1 |
PopNet |
| 2 |
====== |
| 3 |
|
| 4 |
.. figure:: _static/images/bmtk_architecture_popnet_highlight.jpg |
| 5 |
:scale: 40% |
| 6 |
|
| 7 |
|
| 8 |
The PopNet simulation engine uses the `DiPDE simulator <http://alleninstitute.github.io/dipde/>`_ to simulate firing |
| 9 |
rate dynamics of connected population of cells. You can use networks of populations "nodes", or take an existing |
| 10 |
network of individual cell models and PopNet will cluster them into populations. |
| 11 |
|
| 12 |
|
| 13 |
Installation |
| 14 |
------------ |
| 15 |
PopNet supports both Python 2.7 or Python 3.6+, and also requires DiPDE to be installed. See our |
| 16 |
`Installation instructions <installation>`_ for help on installing DiPDE and the BMTK. |
| 17 |
|
| 18 |
|
| 19 |
|
| 20 |
Documentation and Tutorials |
| 21 |
--------------------------- |
| 22 |
Our `github page <https://github.com/AllenInstitute/bmtk/tree/develop/docs/tutorial>`__ contains a number of jupyter-notebook |
| 23 |
tutorials for using the BMTK in general and PopNet specific examples for: |
| 24 |
* `Building a simple two population model <https://github.com/AllenInstitute/bmtk/blob/develop/docs/tutorial/06_population_modeling.ipynb>`_. |
| 25 |
|
| 26 |
About DiPDE |
| 27 |
++++++++++++ |
| 28 |
DiPDE was developed at the Allen Institute for Brain Science for population level modeling of the mammallian cortex. For |
| 29 |
a list of the available features please see the `DiPDE documentation <http://alleninstitute.github.io/dipde/index.html>`_. |
| 30 |
|
| 31 |
For further questions about DiPDE please contact Nicholas Cain (nicholasc at alleninstitute dot org) |
| 32 |
|
| 33 |
|
| 34 |
Previous Materials |
| 35 |
++++++++++++++++++ |
| 36 |
The following are from previous tutorials, workshops, and presentations; and may not work with the latest version of the BMTK. |
| 37 |
* CNS 2018 Workshop: `notebooks <https://github.com/AllenInstitute/CNS_2018_Tutorial/tree/master/bmtk>`__ |
| 38 |
* Summer Workshop on the Dynamic Brain 2018: `notebooks <https://github.com/AllenInstitute/SWDB_2018/tree/master/DynamicBrain/Modeling>`__. |
| 39 |
|
| 40 |
|
| 41 |
Examples |
| 42 |
-------- |
| 43 |
The AllenInstitute/bmtk repo contains a number of PopNet examples, many with pre-built networks and can be immediately ran. These |
| 44 |
tutorials will have the folder prefix *pop_* and to run them in the command-line simply call:: |
| 45 |
|
| 46 |
$ python run_popnet.py config.json |
| 47 |
|
| 48 |
|
| 49 |
Current examples |
| 50 |
++++++++++++++++ |
| 51 |
* `pop_2pop <https://github.com/AllenInstitute/bmtk/tree/develop/examples/pop_2pops>`_ - A simple recurrently connected network with one excitatory and one inhibitory population. |
| 52 |
* `pop_7pops_converted <https://github.com/AllenInstitute/bmtk/tree/develop/examples/pop_7pops_converted>`_ - A conversion our a mouse cortex L4 spiking network into a population rates network. |
| 53 |
|