| 1 |
Main Tutorials |
| 2 |
============== |
| 3 |
|
| 4 |
.. toctree:: |
| 5 |
:maxdepth: 2 |
| 6 |
:titlesonly: |
| 7 |
|
| 8 |
Builder: Using the Network Builder <tutorial_NetworkBuilder_Intro> |
| 9 |
BioNet: Single cell with current injection <tutorial_single_cell_clamped> |
| 10 |
BioNet: Single with with synaptic input <tutorial_single_cell_syn> |
| 11 |
BioNet: Multiple Nodes with single cell-type <tutorial_single_pop> |
| 12 |
BioNet: Heterogeneous network <tutorial_multi_pop> |
| 13 |
PointNet: Point-neuron modeling <tutorial_pointnet_modeling> |
| 14 |
FilterNet: Full-field flashing movie <tutorial_filter_models> |
| 15 |
Auditory FilterNet: Generating stimuli from auditory input <tutorial_auditory_filternet> |
| 16 |
PopNet: Population-based firing rate models <tutorial_population_modeling> |
| 17 |
|
| 18 |
|
| 19 |
|
| 20 |
Also check out the tutorial series from our `annual workshop <workshop>`_. |
| 21 |
|
| 22 |
|
| 23 |
Prerequisites |
| 24 |
------------- |
| 25 |
|
| 26 |
Running with Docker |
| 27 |
+++++++++++++++++++ |
| 28 |
|
| 29 |
If you have Docker installed on your machine then there is a Docker Image with all the prerequists installed - including |
| 30 |
a jupyter notebook server with the tutorials installed. Just run: |
| 31 |
|
| 32 |
.. code:: bash |
| 33 |
|
| 34 |
$ docker pull alleninstitute/bmtk |
| 35 |
$ docker run -v /path/to/local/directory:/home/shared/workspace -p 8888:8888 alleninstitute/bmtk jupyter |
| 36 |
|
| 37 |
and then open a browser to 127.0.0.1:8888/. The tutorials folder will contain the jupyter notebook tutorials for you to |
| 38 |
follow along and modify. However, if you want to save the work permentately make sure to save it in the workspace |
| 39 |
folder. The tutorials and examples folder will be deleted once the docker container has stopped. |
| 40 |
|
| 41 |
you can also use the Docker image to run bmtk build and run scripts. Just replace the python <script>.py <opts> command |
| 42 |
with docker run alleninstitute/bmtk -v /path/to/local/directory:/home/shared/workspace python <script>.py <opts> |
| 43 |
|
| 44 |
Running from source |
| 45 |
+++++++++++++++++++ |
| 46 |
|
| 47 |
The bmtk requires at minimum python 2.7 and 3.6+, as well as additional libraries to use features like building networks |
| 48 |
or running analyses. To install the bmtk it is best recommending to pull the latest from github. |
| 49 |
|
| 50 |
.. code:: bash |
| 51 |
|
| 52 |
$ git clone https://github.com/AllenInstitute/bmtk.git |
| 53 |
$ cd bmtk |
| 54 |
$ python setup.py install |
| 55 |
|
| 56 |
However, to run a simulation on the network the bmtk uses existing open-source simulatiors, which (at the moment) needs |
| 57 |
to be installed separately. The different simulators, which run simulations on different levels-of-resolution, will |
| 58 |
require different software. So depending on the type of simulation to be run |
| 59 |
|
| 60 |
biophysically detailed network (BioNet) - Uses NEURON. |
| 61 |
point-neuron network (PointNet) - Uses NEST. |
| 62 |
population-level network (PopNet) - Uses DiPDE. |
| 63 |
filter models of the visual field (FilterNet) - Uses LGNModels |