Skip to main content

pyDANT: A Python toolbox for Density-based Across-day Neuron Tracking

View pyDANT on GitHub Documentation Status Open In Colab PyPI - Version GitHub License

DANT graphical abstract

pyDANT is a Python toolbox that combines iterative motion correction and density-based clustering to robustly track single neurons across days of high-density recordings.


📄 Published article

Density-based longitudinal neuron tracking in high-density electrophysiological recordings

📚 Read the Documentation

🧮 Check out the MATLAB version (DANT)


⚙️ Installation

This section describes how to install pyDANT.

Install with Anaconda

Anaconda is recommended for managing the pyDANT environment.

conda create -n pyDANT python=3.11
conda activate pyDANT
pip install pyDANT

Install from Python Package Index (PyPI)

You can also install pyDANT directly from PyPI:

pip install pyDANT

Install from Source

If you prefer to install from source, clone the repository and install it manually:

git clone https://github.com/jiumao2/pyDANT.git
cd pyDANT
pip install -e .

🚀 Getting Started

To help you get familiar with the pipeline, we provide two tutorials.

  1. Colab Tutorial: Open the pyDANT Colab demo to run pyDANT in a browser without local setup or pre-downloading data.
  2. Documentation Tutorial: Download the example dataset for pyDANT, then follow the Python tutorial to run pyDANT locally or process your own recordings.

If you encounter any bugs, have questions, or want to suggest a feature, please open an issue. We look forward to your feedback!

📝 Citation

If you use pyDANT in your research, please cite our article:

@article{Huang2026DANT,
    author = {Huang, Yue and Wang, Hanbo and Cao, Jiaming and Chen, Yu and Wang, Xuanning and Zhao, Yujie and Ren, Hengkun and Zheng, Qiang and Yu, Jianing},
    title = {Density-based longitudinal neuron tracking in high-density electrophysiological recordings},
    journal = {Patterns},
    year = {2026},
    doi = {10.1016/j.patter.2026.101590},
    url = {https://doi.org/10.1016/j.patter.2026.101590},
    note = {Available online 17 June 2026}
}

📚 References & Acknowledgements

pyDANT builds upon and integrates several excellent open-source tools. We extend our gratitude to the authors of the following packages:

  • HDBSCAN: Hierarchical Density-Based Spatial Clustering of Applications with Noise. (Campello et al., 2013; McInnes & Healy, 2017).
  • Kilosort: Fast spike sorting with drift correction. (Pachitariu et al., 2024).
  • DREDge: Robust online multiband drift estimation in electrophysiology data. (Windolf et al., 2025).

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Metadata

Release files for pyDANT 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyDANT 1.1.3
File Size Uploaded
pydant-1.1.3.tar.gz 37.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyDANT 1.1.3
File Interpreter ABI Platform
pydant-1.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 77.2 kB

Release files / pydant-1.1.3.tar.gz

Download URL pydant-1.1.3.tar.gz
Size 37.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3aa03c84a2e9fd444dcde3c0df4e56f6c4fb321516b74a40ad7d744290dc7de3
BLAKE2b-256 checksum
How to use checksums
259b6a7a08b7ab66f2b0aee8e0b142819a3b59cba37a841f46758c937f1817ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 13, 2026.

Transparency log

Release files / pydant-1.1.3-py3-none-any.whl

Download URL pydant-1.1.3-py3-none-any.whl
Size 39.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3b0d08c2254b92d3940b8e23eca4e71377fcea2487aa770b348608d7412da42
BLAKE2b-256 checksum
How to use checksums
0b6029a2e00c4391ad3c12dd86ddb21dcb3693a9f2288aaedf143ee650cf2cde
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 13, 2026.

Transparency log

Release history Release notifications | RSS feed

1.1.4

2 release files

This release

1.1.3 This release

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.10

2 release files

0.0.7

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page