Metadata-Version: 2.4
Name: ephyr
Version: 1.0.4
Summary: Ephyr: an open-source platform for visualizing and labeling multimodal electrophysiological data
Author: Life Improvement by Future Technologies (LIFT)
License: GPL-3.0-only
Keywords: Ephyr,EEG,electrophysiology,signal,ephys,MEA,trace
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: COPYRIGHT
Requires-Dist: PyQt6>=6.7.0
Requires-Dist: numpy~=2.2.0
Requires-Dist: pandas>=2.2.0
Requires-Dist: open-ephys-python-tools>=1.0.1
Requires-Dist: pydantic>=2.11.9
Requires-Dist: platformdirs~=4.3.8
Requires-Dist: scipy>=1.14.0
Requires-Dist: pymatreader>=1.2.0
Requires-Dist: tomli>=2.0.0; python_version < "3.11"
Requires-Dist: pyabf>=2.3.8
Requires-Dist: pyedflib>=0.1.42
Requires-Dist: pynwb>=4.0.0
Provides-Extra: dev
Requires-Dist: pyqt6-tools>=6.7.0.0.3; extra == "dev"
Dynamic: license-file

# Ephyr

[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue)](https://ephyr.readthedocs.io/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)

Ephyr is a lightweight yet powerful environment for labelling electrophysiological data. It combines an adaptive interface with intelligent performance scaling to match your machine’s resources, ensuring stable real-time operation even under heavy loads.

Fully open-source and built in Python, the platform provides a flexible API for post-annotation data access. Its add-on architecture lets you extend functionality seamlessly without modifying the core codebase.

![Ephyr application overview](docs/source/_static/getting_started/app_overview.png)

**Documentation:** [https://ephyr.readthedocs.io/](https://ephyr.readthedocs.io/)

## Citation

### Software

If you use this application in your research, please cite the software itself using the Zenodo DOI:

> Kireev, A., & Suchkov, D. (2026). *Ephyr: an open-source platform for visualizing and labeling multimodal electrophysiological data* (Version 1.0.3). Zenodo. https://doi.org/10.5281/zenodo.21678950

### Article (Coming Soon)

A peer-reviewed article describing this application is currently in preparation.
We kindly ask that you consider citing it once it is published.
The official reference and DOI will be updated here and in the `CITATION.cff` file upon publication.

---

## License

Copyright (C) 2026 Life Improvement by Future Technologies (LIFT).

This project is licensed under the **GNU General Public License v3.0** —
see the [LICENSE](LICENSE) and [COPYRIGHT](COPYRIGHT) files for details.
