README.md

BrainDance

Making neural stimulation easier.

Please check out our wiki here!

Easy installation

We recommend using conda for setting up dependencies.

conda create -n brain python=3.11
conda activate brain

pip install git+https://github.com/braingeneers/braindance

RT-Sort installation

To use RT-Sort, install the following additional libraries in your Python environment:

• torch_tensorrt
  • If running on a Windows OS, install torch instead.
  • RT-Sort should still work even if you see torch_tensorrt import warnings. But to remove them, create a new Python environment and install torch_tensorrt FIRST (even before BrainDance).
• diptest
• pynvml
• scikit-learn
• spikeinterface

Kilosort2 installation

To use Kilosort2, you must install Kilosort2 and install the following additional libraries in your Python environment:

• natsort
• spikeinterface

Open Ephys

If you want to read data in real time from an Open Ephys GUI, install the Open Ephys GUI and Falcon Output plugin.

In your Python environment, install the Open Ephys Python package.

pip install open-ephys-python-tools