Installation

SpikeSift supports Python 3.7 and later and can be installed via pip or directly from source.

Installing with pip

To install the latest stable release from PyPI:

pip install spikesift

This will automatically install all required dependencies, including:

  • numpy

  • scipy

  • cython

  • tqdm (used for progress bars)

Installing from Source

To install the latest development version:

  1. Clone the repository:

    git clone https://github.com/vasilisgeorgiadis/spikesift.git
cd spikesift

  2. Install in editable mode (compiles the Cython extensions and links the code locally):

    pip install -e .

Troubleshooting

If installation fails due to build issues or missing compilers:

  1. Make sure your build environment is up to date:

    pip install --upgrade pip setuptools wheel

  2. Ensure a working C++ compiler is available on your system.

  3. Retry the installation.

Note

On Windows, make sure you have the Microsoft C++ Build Tools installed. This is required to compile the Cython extensions. You can install them from:

Verifying Installation

To verify that SpikeSift was installed correctly:

import spikesift
print(spikesift.__version__)

If this runs without error, SpikeSift is ready to use.