Main Tutorials

Also check out the tutorial series from our annual workshop.


Running with Docker

If you have Docker installed on your machine then there is a Docker Image with all the prerequists installed - including a jupyter notebook server with the tutorials installed. Just run:

$ docker pull alleninstitute/bmtk
$ docker run -v /path/to/local/directory:/home/shared/workspace -p 8888:8888 alleninstitute/bmtk jupyter

and then open a browser to The tutorials folder will contain the jupyter notebook tutorials for you to follow along and modify. However, if you want to save the work permentately make sure to save it in the workspace folder. The tutorials and examples folder will be deleted once the docker container has stopped.

you can also use the Docker image to run bmtk build and run scripts. Just replace the python <script>.py <opts> command with docker run alleninstitute/bmtk -v /path/to/local/directory:/home/shared/workspace python <script>.py <opts>

Running from source

The bmtk requires at minimum python 2.7 and 3.6+, as well as additional libraries to use features like building networks or running analyses. To install the bmtk it is best recommending to pull the latest from github.

$ git clone
$ cd bmtk
$ python install

However, to run a simulation on the network the bmtk uses existing open-source simulatiors, which (at the moment) needs to be installed separately. The different simulators, which run simulations on different levels-of-resolution, will require different software. So depending on the type of simulation to be run

biophysically detailed network (BioNet) - Uses NEURON. point-neuron network (PointNet) - Uses NEST. population-level network (PopNet) - Uses DiPDE. filter models of the visual field (FilterNet) - Uses LGNModels