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

pyDANT is a Python toolbox designed for the robust, longitudinal tracking of neurons across multiple recording sessions using high-density probes.


📄 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 have provided an example dataset and a step-by-step walkthrough.

  1. Download the Data: Example Dataset for pyDANT (Figshare)
  2. Run the Pipeline: Follow our comprehensive Tutorial to run the example data 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.0.2.tar.gz (32.2 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.0.2-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pydant-1.0.2.tar.gz
Algorithm Hash digest
SHA256 78bfe5926b5718240918b97c366958f71b291af9edee54a24aedaba53dc4fc65
MD5 77fb8eae23b3fe9c67d7806d669f9fc5
BLAKE2b-256 def9f06a31cbc32a996232e3ec02ce66aad48ed17a3f5cf609c856b3336f9321

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydant-1.0.2.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.0.2-py3-none-any.whl.

File metadata

  • Download URL: pydant-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 33.8 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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4fcffd391d705c3432dead34bf3152df7c0f3702c789e1470d8b70f153dd0b2d
MD5 404f8f04f18d69fafc8bf406ff101441
BLAKE2b-256 142d7b66f5cb2d029c2b051983aba8746d09094051eb0957bbfd513d99132286

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydant-1.0.2-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