Metadata-Version: 2.4
Name: espresso-neuro
Version: 26.5.15
Summary: A framework for preprocessing, processing, visualization, event detection, and event curation of high-density time-series signals and multi-channel data streams.
Project-URL: Repository, https://github.com/AG-CEN/espresso
Project-URL: Issues, https://github.com/AG-CEN/espresso/issues
Project-URL: Changelog, https://github.com/AG-CEN/espresso/blob/master/CHANGELOG.md
Author: Espresso Neuro Maintainers
License: GPL-3.0-or-later
License-File: LICENSE
Keywords: electrophysiology,lfp,neuroscience,ripple-detection,signal-processing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.13
Requires-Dist: numpy>=2.4.4
Requires-Dist: pydantic>=2.13.4
Requires-Dist: pyqt6>=6.11.0
Requires-Dist: pyqtgraph>=0.14.0
Requires-Dist: scipy>=1.17.1
Description-Content-Type: text/markdown

# espresso

A Python framework for preprocessing, processing, visualization, event detection, and event curation of high-density time-series signals and multi-channel data streams.

### Key Capabilities
* **Signal Preprocessing:** Optimized digital filtering pipelines and artifact rejection workflows.
* **Event Detection:** Automated extraction of transient oscillations and sharp-wave ripples.
* **Signal Visualization:** Modern hardware-accelerated time-series traces and interpolated spectrogram displays.
* **Event Curation:** Interactive manual and automated classification workflows to review, filter, and tag detected transient neural events. (Coming soon)


## Installation

```bash
pip install espresso-neuro
```

## Usage

Refer to the [examples/](examples/) directory for complete, runnable pipeline scripts demonstrating signal processing, downsampling metrics, and hardware-accelerated user interface execution.

## License & Attribution

This project is licensed under the GNU General Public License v3 - see the [LICENSE](LICENSE) file for details.

### Third-Party Code
* The ripple detection module in `src/espresso/hfo/ripple_detector.py` contains algorithm logic adapted from the [FKLab Python Core library](https://bitbucket.org/kloostermannerflab/fklab-python-core) by the Kloosterman Lab.
