https://github.com/warptengood/eeg_annotator
Desktop EEG annotation tool for neurophysiologists. View, analyze, and annotate EDF files with lazy-loaded rendering and low memory footprint.
https://github.com/warptengood/eeg_annotator
annotation-tool brain desktop-app edf eeg eeg-analysis eeg-viewer medical neurophysiology neuroscience pyqt6 pyqtgraph python signal-processing
Last synced: 12 days ago
JSON representation
Desktop EEG annotation tool for neurophysiologists. View, analyze, and annotate EDF files with lazy-loaded rendering and low memory footprint.
- Host: GitHub
- URL: https://github.com/warptengood/eeg_annotator
- Owner: warptengood
- License: gpl-3.0
- Created: 2026-01-10T11:33:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-05-23T09:25:12.000Z (12 days ago)
- Last Synced: 2026-05-23T09:30:20.928Z (12 days ago)
- Topics: annotation-tool, brain, desktop-app, edf, eeg, eeg-analysis, eeg-viewer, medical, neurophysiology, neuroscience, pyqt6, pyqtgraph, python, signal-processing
- Language: Python
- Homepage:
- Size: 7.26 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ziyatron EEG Annotator
**Clinical-grade EEG annotation for neurophysiologists — fast, free, and runs on any laptop.**
Load any EDF file, navigate the trace, and mark regions with 49 clinical labels — all without a hospital workstation. Streams data on demand so 100 MB+ files open in seconds and use under 50 MB of RAM.
---
## Download
> **No installation required — just unzip and run.**
**[Download the latest release](https://github.com/warptengood/eeg_annotator/releases/latest)** — pre-built executables for Windows and macOS.
---
## Features
**Viewing**
- Load EDF / EDF+ files of any size (tested up to 1 GB+)
- Bipolar Double Banana, Bipolar Transverse, and Average montages
- Adjustable scale (1–1000 µV/mm), high-pass / low-pass filtering
- Smooth pan with A/D keys or mouse drag; zoom with scroll wheel
- Jump to any time with the Goto field
**Annotation**
- Draw rectangles across any time range and channel selection
- 49 pre-defined clinical labels (SEIZ, ARTF, AR, MUSC, EYBL, …)
- Move, resize, copy/paste, and delete annotations
- Ctrl+Z undo
**File I/O**
- Annotations auto-save as CSV next to the EDF file
- Auto-loads existing annotation file on open
- One CSV per montage; backward-compatible with v1.0
---
## User Manual
Full usage instructions, keyboard shortcuts, and label reference: **[MANUAL.md](MANUAL.md)**
---
## Quick Start (from source)
```bash
git clone https://github.com/warptengood/eeg_annotator.git
cd eeg_annotator
uv sync
python main.py
```
> Always run `python main.py` from the project root — not `python src/main.py`.
---
## Built With
- [MNE-Python](https://mne.tools/) — EEG data I/O
- [PyQt6](https://www.riverbankcomputing.com/software/pyqt/) — GUI framework
- [PyQtGraph](https://www.pyqtgraph.org/) — high-performance time-series rendering
---
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, architecture, and how to add montages or labels.
---
## Support
- Bug reports & feature requests: [GitHub Issues](https://github.com/warptengood/eeg_annotator/issues)
- Email: kenesyerassyl@gmail.com
---
## Author & License
**Ziyatron EEG Annotator** is created and maintained by **Kenes Yerassyl**.
- Original repository: [github.com/warptengood/eeg_annotator](https://github.com/warptengood/eeg_annotator)
- Contact: kenesyerassyl@gmail.com
This project is licensed under the **GNU General Public License v3.0** — see [LICENSE](LICENSE) for details.
Copyright © 2024–2026 Kenes Yerassyl. All source files carry the full GPL-3.0 copyright header.
If you encounter a copy of this software without proper attribution, it is in violation of the license terms.