bmtool 0.1.0

BMTools

bmtools

A collection of scripts to make developing networks in BMTK easier.

Getting Started

Installation

git clone https://github.com/tjbanks/bmtools
cd bmtools
python setup.py install

For developers who will be pulling down additional updates to this repository regularly use the following instead.

python setup.py develop

Example Use

> cd your_bmtk_model_directory
> bmtools
Usage: bmtools [OPTIONS] COMMAND [ARGS]...

Options:
  --verbose  Verbose printing
  --help     Show this message and exit.

Commands:
  debug
  plot
  util

>  
> bmtools plot 
Usage: bmtools 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
>
> bmtools plot positions

Planned future features

bmtools build
    Create a starting point network
    Download sample networks

bmtools plot
    Plot variable traces
    Plot spike rasters
    Plot cell positions
    Plot connection matricies

bmtools debug 
    list cell types available for single debug
    Run a single cell in the network
    Isolate a single cell in the network