Quickstart

Getting Started with Cellector

Installation

pip install cellector

Basic Usage

Here’s a minimal example to get you started:

import cellector
from cellector import RoiProcessor, CellectorManager

# Create a RoiProcessor instance from suite2p output
roi_processor = cellector.io.create_from_suite2p("path/to/suite2p/dir")

# can also create from a suite3d results directory, everything else should work the same
# roi_processor = cellector.io.create_from_suite3d("path/to/suite3d/results/dir")

# Create a CellectorManager instance
manager = CellectorManager.make_from_roi_processor(roi_processor)

# Launch the GUI
from cellector.gui import SelectionGUI
gui = SelectionGUI(roi_processor)