Kilosort v4.0.3

This release adds pc_features.npy and pc_feature_ind.npy for use with feature view in Phy. Additionally, the GUI backend was updated from PyQt5 to QtPy, which is compatible with PyQt5, PyQt6, and PySide. This should result in fewer installation issues. If you previously installed Kilosort from source, you will need to reinstall after updating the code to update your GUI dependencies.

Several bug fixes are included as well:

• dminx will no longer be determined automatically, the default value is 32. This removes a bug with that behavior related to checkerboard electrode layouts. You may need to update the value in the GUI under "extra settings," or click on "reset GUI," to update this.
• Setting n_pcs to values other than 6 will no longer cause a crash.
• Fixed bug that could cause negative spike times to be detected for first batch.
• Added informative errors related to dminx and electrode spacing.
• Misc fixes to GUI behavior.

Full Changelog: v4.0.2...v4.0.3

Kilosort 4

Initial release of Kilosort4, linked with paper.

Kilosort 3.0

UPDATE 3/8/24: this version has the "spike holes" bug from issue #594 and is only left here as a reference. Please use the new release above "Kilosort 3.0 patch0" where the main bug has been fixed. We will continue to investigate if other bugs are left that produce this behavior.

This is the last version of Kilosort 3.0 and the last Kilosort version in Matlab. No further support or code changes for Kilosort 3 will be provided beyond this release.

Kilosort 2.5

UPDATE 3/8/24: this version has the "spike holes" bug from issue #594 and is only left here as a reference. Please use the new release above "Kilosort 2.5 patch0" where the main bug has been fixed. We will continue to investigate if other bugs are left that produce this behavior.

Kilosort 2.0

This release is the final Kilosort 2.0 build, before moving on to v2.5. A new drift correction algorithm is introduced in v2.5, which makes obsolete the drift tracking approach from v2.0. In addition, the two algorithms are incompatible and we are dropping support for drift tracking from v2.5 onwards. Users of Neuropixels 1.0 and 2.0 should transition directly to Kilosort 2.5.

Nonetheless, we expect some users will get better performance from v2.0, at least initially. Recording configurations that may benefit more from v2.0 than v2.5 are: tetrodes, single-channel recordings such as from a Utah array, probes with >30um vertical spacing.

To learn more about Kilosort 2.0, read the supplementary material and figures in Stringer, Pachitariu et al, Science 2019, and the wiki page of the v2.0 release. The following talks may also be useful: talk1, talk2.

release for Zenodo DOI

Merge pull request #159 from JoseGuzman/patch-1

Correct penalty parameter in Readme

Former-commit-id: 67a42a87b866b6150385a46eec358adb349d9ff2