Getting Started#

Installation#

  1. Using Pip:
    $ pip install roiextractors
    
  2. Cloning the github repo:
    $ git clone https://github.com/SpikeInterface/spikeinterface.git
    $ cd spikeinterface
    $ pip install --editable .
    

You can also install the optional dependencies by installing the package with the following command:

$ pip install "roiextractors[full]"

The full extra installs format-specific dependencies.

For development, testing, or building documentation, use dependency groups:

$ pip install --group test
$ pip install --group docs

These commands install the test and documentation dependencies, respectively.

What is RoiExtractors#

Python-based module for extracting from, converting between, and handling recorded and optical imaging data from several file formats. Inspired by SpikeExtractors.

_images/roiextractors_overview.jpg