Skip to main content

A Python package for tracking neurons across days

Project description

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.


📄 Preprint

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

📚 Read the Documentation

🧮 Check out the MATLAB version (DANT)


Installation

This section describes installation of the 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 preprint:

@article {Huang2025DANT,
    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},
    year = {2025},
    doi = {10.64898/2025.12.19.695632},
    publisher = {Cold Spring Harbor Laboratory},
    URL = {https://www.biorxiv.org/content/early/2025/12/23/2025.12.19.695632},
    journal = {bioRxiv}
}

📚 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydant-1.1.0.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydant-1.1.0-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file pydant-1.1.0.tar.gz.

File metadata

  • Download URL: pydant-1.1.0.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pydant-1.1.0.tar.gz
Algorithm Hash digest
SHA256 cd8982c98e01a07237147d04773b7cfcb671d3051cc4425b47ab3767f0c2e483
MD5 a9276f0ca5d96bf6c10a93848944faa7
BLAKE2b-256 387d5f4ddd9241d5855f58852d158ad00c0588d56248579b5c062bebf9c0f38c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydant-1.1.0.tar.gz:

Publisher: python-publish.yml on jiumao2/pyDANT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydant-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: pydant-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pydant-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c95c2678699ec8b2fe0ba3a276689e412fdf32ef890ee9df3318b97d7583cbec
MD5 d6408a14eb33f37809ebfda4dc46d190
BLAKE2b-256 88784a6bb748c747c60f69c05767ff0f5e6d85c501e7286f4f0eddee626f9bea

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydant-1.1.0-py3-none-any.whl:

Publisher: python-publish.yml on jiumao2/pyDANT

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page