Getting Started
================

Installation
------------

#. Using Pip:
    .. code-block:: shell

       $ pip install roiextractors

#. You can check for any missing packages by explicitly installing from the `requirements <https://github.com/catalystneuro/roiextractors/blob/master/requirements.txt/>`_ file:
    .. code-block:: shell

        $ pip install -r requirements.txt

#. **Cloning the github repo**:
    .. code-block:: shell

        $ git clone https://github.com/SpikeInterface/spikeinterface.git
        $ cd spikeinterface
        $ python setup.py install (or develop)

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 <https://github.com/SpikeInterface/spikeextractors/>`_.

.. image:: ./_images/roiextractors_overview.jpg