Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (70 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

105 lines (70 loc) · 2.15 KB

Contributing to Ziyatron EEG Annotator

Thank you for your interest in contributing! This document covers dev setup, architecture, and common extension patterns.

Dev Setup

git clone https://github.com/warptengood/eeg_annotator.git
cd eeg_annotator

python -m venv venv
source venv/bin/activate        # Windows: venv\Scripts\activate

pip install -r requirements.txt
pip install -r requirements-dev.txt

python main.py

Always run python main.py from the project root (not python src/main.py).

Architecture

Data flow: user action → AppState signal → MainWindow handler → data_streamer.get_window() → plot_widget.update_plot()

Memory rule: never use preload=True when opening EDF files. The streamer loads only the visible 6–10 s window into an LRU cache (max 5 windows).

Common Extensions

Add a diagnosis label

Edit src/core/config.py and append to the diagnosis list.

Add a montage

Create resources/montages/my_montage.yaml:

Monopolar

CH1-CH2:
 - "EEG CH1-CH2" # or whatever the original channel name is

Bipolar

If you want to build bipolar montages by using monopolar as anode and cathode

CH1-CH2:
  REF: # for referential monopolar (ear-lobe in this case)
  - EEG CH1-A1
  - EEG CH2-A2
  AV: # for average monopolar
  - EEG CH1-AV
  - EEG CH2-AV

It will appear in the montage dropdown automatically.

Add a toolbar control

  1. Add widget to ControlToolbar (src/views/control_toolbar.py)
  2. Add signal to AppState (src/models/app_state.py)
  3. Emit the signal from the toolbar
  4. Connect and handle it in MainWindow (src/views/main_window.py)

Testing (TODO)

# Unit tests
pytest tests/

# With coverage
pytest --cov=src tests/

# Memory profiling (expect <50 MB with a 100 MB EDF file)
python -m memory_profiler src/main.py

Building Executables

pyinstaller main.spec
# Output: dist/eeg_annotator/

# Check bundle size (should be <200 MB)
du -sh dist/eeg_annotator/

Code Style (TODO)

black src/       # formatting
flake8 src/      # linting

Follow PEP 8. Add docstrings to public functions.