Skip to content

Commit

Permalink
Merge pull request #146 from NeurodataWithoutBorders/add/bmtk
Browse files Browse the repository at this point in the history
Add BMTK tool
  • Loading branch information
bendichter authored Jan 2, 2024
2 parents 6e12ee3 + 22a5dc3 commit 14f78eb
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/source/tools/acquisition_tools_home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Acquisition and Control Tools
openephys/openephys
visiomode/visiomode
arcontrol/arcontrol
bmtk/bmtk


This page is a collection of tools we are cataloging as a convenience reference for NWB users. This is not a comprehensive list of NWB tools. Many of these tools are built and supported by other groups, and are in active development. If you would like to contribute a tool, please see the instructions :nwb-overview-src:`here <>`.
Expand Down Expand Up @@ -78,6 +79,22 @@ Controlling and Recoding Behavioral Tasks

<br/>

.. raw:: html

<hr>
<br />

Brain Data Modeling and Simulation
-----------------------------------

.. image:: bmtk/bmtk_icon.png
:class: align-left
:width: 180

.. include:: bmtk/bmtk.rst
:start-after: .. short_description_start
:end-before: .. short_description_end

.. note::

**Disclaimer:** Reference herein to any specific product, process, or service
Expand Down
24 changes: 24 additions & 0 deletions docs/source/tools/bmtk/bmtk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _analysistools-bmtk:

Brain Modeling Toolkit (BMTK)
-----------------------------

.. short_description_start
:ref:`analysistools-bmtk`, SONATA, and Visual Neuronal Dynamics (VND) are mutually integrated software tools that are particularly suited to support large-scale bio-realistic brain modeling, but are applicable to a variety of neuronal modeling applications. BMTK is a suite for building and simulating network models at multiple levels of resolution, from biophysically-detailed, to point-neuron, to population-statistics approaches. The modular design of BMTK allows users to easily work across different scales of resolution and different simulation engines using the same code interface. The model architecture and parameters, as well as simulation configuration, input, and output are stored together in the SONATA data format. Models and their output activity can then be visualized with the powerful rendering capabilities of VND. :bdg-link-primary:`Docs <https://alleninstitute.github.io/bmtk>` :bdg-link-primary:`Tutorial <https://alleninstitute.github.io/bmtk/tutorials.html>` :bdg-link-primary:`NWB Spike Stimulus <https://alleninstitute.github.io/bmtk/ecephys_probe.html>` :bdg-link-primary:`Source <https://github.com/AllenInstitute/bmtk>`
.. image:: https://img.shields.io/github/stars/AllenInstitute/bmtk?style=social
:alt: GitHub Repo stars for BTMK
:target: https://github.com/AllenInstitute/bmtk

.. short_description_end
.. image:: bmtk_levels_of_resolution_sm.png
:class: align-left
:width: 800


**Reference:**

Dai et al. Brain Modeling Toolkit: An open-source software suite for multiscale modeling of brain circuits. PLoS Comput Biol 16(11): e1008386. https://doi.org/10.1371/journal.pcbi.1008386
Binary file added docs/source/tools/bmtk/bmtk_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 14f78eb

Please sign in to comment.