Skip to main content

A lightweight tool for viewing EEGLAB .set files using MNE-QT Browser

Project description

🧠 AutoCleanEEG-View

AutoCleanEEG-View is a simple yet powerful tool for neuroscientists, researchers, and EEG enthusiasts to visualize EEGLAB .set, .edf, and .bdf files using the modern MNE-QT Browser.

✨ Features

  • Simple Interface: Just one command to view your EEG data
  • Interactive Visualization: Pan, zoom, filter, and explore your EEG signals
  • Automatic Channel Type Detection: Properly handles EEG, EOG, ECG channels
  • Event Markers: View annotations and event markers in your recordings
  • Cross-Platform: Works on macOS and Linux

🚀 Quick Start

Installation

pip install autocleaneeg-view

Basic Usage

# View an EEG file (default behavior)
autoclean-view path/to/yourfile.set

# Explicitly open the viewer (also supported for clarity)
autoclean-view path/to/yourfile.set --view

# Load without viewing (just validate the file)
autoclean-view path/to/yourfile.set --no-view

🧪 Test With Simulated Data

Don't have EEG data handy? Generate realistic test data to try it out:

# Generate a 10-second recording with 32 channels
python scripts/generate_test_data.py --output data/simulated_eeg.set

# Quick test all in one step
./scripts/test_with_simulated_data.sh

Simulation Options

Customize your simulated data:

python scripts/generate_test_data.py --help
  • --duration 60: Create a 60-second recording
  • --sfreq 512: Set sampling rate to 512 Hz
  • --channels 64: Generate 64 channel EEG
  • --no-events: Disable simulated event markers
  • --no-artifacts: Generate clean data without eye blinks/artifacts

📋 Requirements

  • Python 3.9 or higher
  • MNE-Python 1.7+
  • MNE-QT-Browser 0.5.2+
  • PyQt5 (macOS) or compatible Qt backend

For detailed installation instructions, see INSTALL.md.

📝 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autocleaneeg_view-0.1.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autocleaneeg_view-0.1.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file autocleaneeg_view-0.1.2.tar.gz.

File metadata

  • Download URL: autocleaneeg_view-0.1.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for autocleaneeg_view-0.1.2.tar.gz
Algorithm Hash digest
SHA256 92c3508701ab5dedeb431409290f0b3b0ba889b61cd9ea6ade2fba16e368206d
MD5 efd8ae5be33c13d597c41610331280dd
BLAKE2b-256 c0f4b4a8402c719ac355054c0dada3fb702e6efcd47146f91d4af9690d9d4bf7

See more details on using hashes here.

File details

Details for the file autocleaneeg_view-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for autocleaneeg_view-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e34ee7011c17e036fa97e4f5140699524cc77af0028786065ef2d326d0c7d83f
MD5 c0fcd89100918392703d98c7f9ded66b
BLAKE2b-256 bb2aab197758bf541c828e131ad0d4f33bbd594614f4ee9bb3cef4b9b9b30fd2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page