Skip to main content

A simplified MNE-Python wrapper for teaching EEG analysis

Project description

mini-mne

A simplified wrapper around MNE-Python for teaching EEG data analysis. mini-mne exposes only the essential classes and methods, reducing the cognitive load for learners who are new to EEG preprocessing and analysis.

Installation

pip install --upgrade mini-mne

Requires Python ≥ 3.11.

Usage

mini-mne follows the standard EEG analysis pipeline: load continuous data → epoch around events → compute ERPs.

from mini_mne import SimpleRaw, SimpleEpoch, SimpleEvoked, plot_evokeds

# Load data (downloads the MNE ERP-CORE example dataset if no path is given)
raw = SimpleRaw()

# Inspect the data
print(raw)
print(raw.sampling_frequency)  # Hz
print(raw.channel_names)
print(raw.duration)            # seconds

# Preprocess
raw = raw.filter(l_freq=0.1, h_freq=40.0)
raw = raw.re_reference()

# Extract events from annotations
events, event_id = raw.get_events()

# Epoch the data
epochs = SimpleEpoch(raw, events, event_id,
                     tmin=-0.2, tmax=0.8,
                     baseline=(-0.2, 0),
                     reject={"eeg": 100e-6})

print(epochs)
print(epochs.event_types)
print(epochs.dropped_epochs)

# Compute ERPs
evokeds = epochs.average(by_event_type=True)

# Plot
plot_evokeds(evokeds)

Classes

Class Wraps Purpose
SimpleRaw mne.io.Raw Continuous EEG data
SimpleEpoch mne.Epochs Segmented data around events
SimpleEvoked mne.Evoked Averaged ERP

Licence

mini-mne is licenced under the BSD-3-Clause licence.

Acknowledgements

mini-mne is built on top of MNE-Python. The default example dataset is from the ERP-CORE dataset (Kappenman et al., 2021).

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

mini_mne-0.1.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

mini_mne-0.1.2-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mini_mne-0.1.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mini_mne-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1d546a445fd6f5ce92cee140d81ecb65b2a9a001bb6bab26e54ab4cbe49c7d4d
MD5 afb4d26021023226f12d7921a1d948a3
BLAKE2b-256 f6fa6fcfc0ef61c6ac621aaa4220267950ee063067d938c24cd1d45e67c63827

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mini_mne-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mini_mne-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 96eaae52614059394c4e50e87593d35f663ceca1ab3721a8bc29e601ec7e4ec2
MD5 4b4a6f8d8780a629bdb2e1c069d92133
BLAKE2b-256 58b3f6b1f6b23fb056628b8d32b1b02eb67e9d6be23e93e09d680c060b3a02f8

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