For developers who will be pulling down additional updates to this repository regularly use the following instead.
git clone https://github.com/cyneuro/bmtool.git
cd bmtool
python setup.py develop
Then download updates (from this directory) with
git pull
CLI
Many of modules available can be accesed using the command line
>cd your_bmtk_model_directory
> bmtool
Usage: bmtool [OPTIONS] COMMAND [ARGS]...
Options:
--verbose Verbose printing
--help Show this message and exit.
Commands:
debug
plot
util
>> bmtool plot
Usage: bmtool plot [OPTIONS] COMMAND [ARGS]...
Options:
--config PATH Configuration file to use, default: "simulation_config.json"
--no-display When set there will be no plot displayed, useful for saving
plots
--help Show this message and exit.
Commands:
connection Display information related to neuron connections
positions Plot cell positions for a given set of populations
raster Plot the spike raster for a given population
report Plot the specified report using BMTK's default report plotter>
The single cell module can take any neuron HOC object and calculate passive properties, run a current clamp, calculate FI curve, or run a ZAP. The module is designed to work with HOC template files and can also turn Allen database SWC and json files into HOC objects and use those. The examples below uses "Cell_Cf" which is the name of a HOC templated loaded by the profiler.
Can provide any single cell module with either name of Hoc template or a HOC object. If you are wanted to use Allen database SWC and json files you can use the following function
Injection location: Cell_Cf[22].soma[0](0.5)
Recording: Cell_Cf[22].soma[0](0.5)._ref_v
ZAP current simulation running...
Chirp current injection with frequency changing from 0 to 15 Hz over 15 seconds
Impedance is calculated as the ratio of FFT amplitude of membrane voltage to FFT amplitude of chirp current
Single Cell Tuning
From a BMTK Model directory containing a simulation_config.json file:
Segregate your channel activation for an easier time tuning your cells.
> bmtool util cell vhseg --help
Usage: bmtool util cell vhseg [OPTIONS]
Alturki et al. (2016) V1/2 Automated Segregation Interface, simplify
tuning by separating channel activation
Options:
--title TEXT
--tstop INTEGER
--outhoc TEXT Specify the file you want the modified cell template
written to
--outfolder TEXT Specify the directory you want the modified cell
template and mod files written to (default: _seg)
--outappend Append out instead of overwriting (default: False)
--debug Print all debug statements
--fminpa INTEGER Starting FI Curve amps (default: 0)
--fmaxpa INTEGER Ending FI Curve amps (default: 1000)
--fincrement INTEGER Increment the FI Curve amps by supplied pA (default:
100)
--infvars TEXT Specify the inf variables to plot, skips the wizard.
(Comma separated, eg: inf_mech,minf_mech2,ninf_mech2)
--segvars TEXT Specify the segregation variables to globally set,
skips the wizard. (Comma separated, eg:
mseg_mech,nseg_mech2)
--eleak TEXT Specify the eleak var manually
--gleak TEXT Specify the gleak var manually
--othersec TEXT Specify other sections that a window should be
generated for (Comma separated, eg: dend[0],dend[1])
--help Show this message and exit.
Examples
Wizard Mode (Interactive)
> bmtool util cell vhseg
? Select a cell: CA3PyramidalCell
Using section dend[0]
? Show other sections? (default: No) Yes
? Select other sections (space bar to select): done (2 selections)
? Select inf variables to plot (space bar to select): done (5 selections)
? Select segregation variables [OR VARIABLES YOU WANT TO CHANGE ON ALL SEGMENTS at the same time] (space bar to select): done (2 selections)
This module contains helper functions and classes that work with BMTK's NetworkBuilder module in building networks. It facilitates building reciprocal connections, distance dependent connections, afferent connections, etc. See documentation inside the script connectors.py for more notes on usage.
All connector example below use the following network node structure
Unidirectional connector - Object for building unidirectional connections in bmtk network model with given probability within a single population (or between two populations).
Recipical connector - Object for building connections in bmtk network model with reciprocal probability within a single population (or between two populations)
CorrelatedGapJunction - Object for building gap junction connections in bmtk network model with given probabilities within a single population which could be correlated with the recurrent chemical synapses in this population.
OneToOneSequentialConnector - Object for building one to one correspondence connections in bmtk network model with between two populations. One of the population can consist of multiple sub-populations.
Generates a table of the percent connectivity of neuron populations.Method can change if you want the table to be total percent connectivity, only unidirectional connectivity or only bi directional connectvity
While gap junctions can be include in the above plots, you can use this function to only view gap junctions.Type can be either 'convergence' or 'percent' connections to generate different plots
The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.