Metadata-Version: 2.4
Name: driftplots
Version: 0.1.0
Summary: Interactively visualise Kilosort drift maps for checking inter-session alignment.
Author-email: Joseph Ziminski <joseph.j.ziminski@gmail.com>
License-Expression: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: spikeinterface
Requires-Dist: pyqtgraph
Requires-Dist: PySide6
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: setuptools-scm; extra == "dev"
Dynamic: license-file

# driftplots

`driftplots` is a package for plotting drift maps from Kilosort (1-4) or SpikeInterface's `SortingAnalyzer`.

Interactive mode (above) allows selection of spikes to view the associated template, and
is useful for checking the alignment of two sorted sessions:

<p align="center">
  <img src="https://github.com/user-attachments/assets/b2acde53-1744-4280-8ef2-d9c01b003c92" width="700" />
</p>

Static matplotlib figures are also supported, and come with a range of options
for customising the displayed data and plots:

<p align="center">
  <img width="562" height="370" alt="matplotlib-example" src="https://github.com/user-attachments/assets/5a13caaa-dbdd-481b-863d-c0e643add070" />
</p>

`driftplots` is currently in **beta** release. Please get in touch if you find any issues.

## Get started

The package can be installed with:
```
pip install driftplots
```

See the [documentation](driftplots.neuroinformatics.dev) and locally runnable
[examples](https://github.com/neuroinformatics-unit/driftplots/tree/main/examples) for full details on how to use `driftplots`.
