Skip to content

neuro-py

Analysis of neuroelectrophysiology data in Python.
CI/CD CI - Test Docs
Package PyPI - Version PyPI - Python Version PyPI - Downloads
Repository GitHub - Issues Commits Contributors Downloads
Metadata GitHub - License code style - black docstring - numpydoc linting - Ruff

Overview

neuro_py is a Python package for analysis of neuroelectrophysiology data. It is built on top of the nelpy package, which provides core data objects. neuro_py provides a set of functions for analysis of freely moving electrophysiology, including behavior tracking utilities, neural ensemble detection, peri-event analyses, robust batch analysis tools, and more.

Tutorials are here and more will be added.

Installation

pip install neuro-analysis-py

Development

git clone
cd neuro_py
pip install -e .

To sync the nelpy dependency to latest version, use following instead,

pip install -e . --force-reinstall --no-cache-dir

Usage

import neuro_py as npy

Dependencies

For ease of use, this package uses nelpy core data objects. See nelpy

Testing

pytest

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Authors