You can run Kilosort4 without installing it locally using google colab. An example colab notebook is available here: 
. It will download some test data, run kilosort4 on it, and show some plots. Talk describing Kilosort4 is here.
Example notebooks are provided in the docs/source/tutorials folder and in the docs. The notebooks include:
basic_example: sets up run on example data and shows how to modify parametersload_data: example data format conversion through SpikeInterfacemake_probe: making a custom probe configuration.If you use Kilosort1-4, please cite the paper:
Pachitariu, M., Sridhar, S., Pennington, J., & Stringer, C. (2024). Spike sorting with Kilosort4. Nature Methods , 21, pages 914–921
Reusing parameters from previous versions: This probably will not work well. Kilosort4 is a new algorithm, and the main parameters (the thresholds) can affect the results in a different way for your data. Please start with the default parameters and adjust from there based on what you see in Phy. For descriptions of Kilosort4's parameters, you can mouse-over their names in the GUI or look at kilosort.parameters.py.
Running Kilosort4 with SpikeInterface: We do not provide support for SpikeInterface, and are not involved in their development (or vise-versa). If you encounter problems running Kilosort4 through SpikeInterface, please try running Kilosort4 directly instead. In particular, the KS4 GUI is a useful tool for checking that your probe and data are formatted correctly.
Warning :bangbang:: There were two bugs in Kilosort 2, 2.5 and 3 (but not 4) which caused fewer spikes to be detected in ~7ms periods at batch boundaries (every 2.1866s, issue #594). The patch1 releases fix these bugs, please use the new default NT and ntbuff parameters.
Linux and Windows 64-bit are supported for running the code. At least 8GB of GPU RAM is required to run the software (see docs for more recommendations). The software has been tested on Windows 10 and Ubuntu 20.04.
If you have an older kilosort environment you can remove it with conda env remove -n kilosort before creating a new one.
conda for python 3 in the pathconda create --name kilosort python=3.9. Python 3.10 should work as well.conda activate kilosortpython -m pip install kilosort[gui]. If you're on a zsh server, you may need to use python -m pip install "kilosort[gui]" .python -m pip install kilosort.pip uninstall torchconda install pytorch pytorch-cuda=11.8 -c pytorch -c nvidiaNote you will always have to run conda activate kilosort before you run kilosort. If you want to run jupyter notebooks in this environment, then also conda install jupyter or pip install notebook, and python -m pip install matplotlib.
If step 8 does not work, you need to make sure the NVIDIA driver for your GPU is installed (available here). You may also need to install the CUDA libraries for it, we recommend CUDA 11.8.
If pytorch installation still fails, follow the instructions here to determine what version of pytorch to install. The Anaconda install is strongly recommended on Windows, and then choose the CUDA version that is supported by your GPU (newer GPUs may need newer CUDA versions > 10.2). For instance this command will install the 11.8 version on Linux and Windows (note the torchvision and torchaudio commands are removed because kilosort doesn't require them):
conda install pytorch pytorch-cuda=11.8 pynvml -c pytorch -c nvidia
This video has step-by-step installation instructions for NVIDIA drivers and pytorch in Windows (ignore the environment creation step with the .yml file, we have an environment already, to activate it use conda activate kilosort).
python -m kilosortLOAD. The data should now be visible.Run. This will run the pipeline and output the results in a format compatible with Phy, the most popular spike sorting curating software.Some users have encountered the following error (or similar ones with slight variations) when attempting to launch the Kilosort4 GUI:
QObject::moveToThread: Current thread (0x2a7734988a0) is not the object's thread (0x2a77349d4e0).
Cannot move to target thread (0x2a7734988a0)
qt.qpa.plugin: Could not load the Qt platform plugin "windows" in "<FILEPATH>" even though it was found.
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
Available platform plugins are: minimal, offscreen, webgl, windows.
This is not specific to Kilosort4, it is a general problem with PyQt (the GUI library we chose to develop with) that doesn't appear to have a single cause or fix. If you encounter this error, please check issue 597 and issue 613 for some suggested solutions.
Phy provides a manual clustering interface for refining the results of the algorithm. Kilosort4 automatically sets the "good" units in Phy based on a <10% estimated contamination rate with spikes from other neurons (computed from the refractory period violations relative to expected).
Check out the Phy repo for more install instructions. We recommend installing Phy in its own environment to avoid package conflicts.
After installation, activate your Phy environment and navigate to the results directory from Kilosort4 (by default, a folder named kilosort4 in the same directory as the binary data file) and run:
phy template-gui params.py
To get the most up-to-date changes to the code, clone the repository and install in editable mode in your Kilosort environment, along with the other installation steps mentioned above. Using the included environment.yml to create your environment is recommended, which will also install pytest and the cuda version of Pytorch.
git clone git@github.com:MouseLand/Kilosort.git
conda env create -f environment.yml
conda activate kilosort
pip install -e Kilosort[gui]
Then run all tests with:
pytest --runslow
To run on GPU:
pytest --gpu --runslow
Omitting the --runslow flag will only run the faster unit tests, not the slower regression tests.
FAQs
spike sorting pipeline
We found that kilosort demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.