Skip to main content

BipolarExplorerMNE

A simple Python package built on top of MNE-Python to visualize bipolar montages of non-EEG signals (e.g., ECG, EMG, EOG) from .EDF or .EEG files, even when channel names are inconsistent or messy.


🚀 Motivation

Working with physiological recordings from hospital systems often means dealing with inconsistently named or misconfigured channels. While EEG data typically follows the 10-20 naming convention, ECG and other physiological signals often don't — you'll find channel names like:

  • ECG-, ECG+
  • E, Ecg
  • -0, Ecg
  • ...and other unpredictable combinations.

On top of that, electrode placement can sometimes be reversed, making interpretation more difficult.

This package helps quickly visualize possible bipolar combinations between selected channels, so you can identify useful signals and confirm polarity before moving on to analysis.


📦 Features

  • Load .EDF or .EEG files using MNE
  • Visualize bipolar signals from non-EEG channels
  • Interactive (plotly) plots to scroll and inspect signals
  • Designed for manual exploration and verification

🔧 Installation

You can install the package via pip (if uploaded to PyPI) or directly from GitHub:

pip install bipolar-explorer-mne

or

pip install git+https://github.com/anascacais/BipolarExplorerMNE.git

Usage

from bipolar_explorer_mne.bipolar_explorer import BipolarExplorer

# Load the data
explorer = BipolarExplorer(filepath='test_file.edf')

# Optional: list all available channels
explorer.list_channels()

# Open the UI
bipolar_config, id = explorer.explore(extra_ui_info=['id'])

Notes

  • This tool is primarily meant for channel exploration, not as an automated pipeline.
  • You should still verify the actual electrode placements and channel meaning based on metadata or clinical notes when available.
  • It assumes you have MNE installed and working in your environment.

Metadata

Release files for bipolar-explorer-mne 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bipolar-explorer-mne 0.1.3
File Size Uploaded Provenance
bipolar_explorer_mne-0.1.3.tar.gz 6.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for bipolar-explorer-mne 0.1.3
File Interpreter ABI Platform
bipolar_explorer_mne-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 14.5 kB

Release files / bipolar_explorer_mne-0.1.3.tar.gz

Download URL bipolar_explorer_mne-0.1.3.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0e633a6ab6c7b31065d43579ca49b113513611a4fa4ded37fc38c4075094cf64
BLAKE2b-256 checksum
How to use checksums
a764164e66c71b6ec8afdb98053d6a6a96be2928a6f3fa0f2940913e86aa4e29
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 26, 2025.

Transparency log

Release files / bipolar_explorer_mne-0.1.3-py3-none-any.whl

Download URL bipolar_explorer_mne-0.1.3-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e6f20a53783bb8ddc9f4b2ef0e719b8e30717603231e1b6ac86810305dd1b170
BLAKE2b-256 checksum
How to use checksums
c590fc1fa920ee1218703bec0a67d1241f9d61b8692670d30367114e6208f2d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 26, 2025.

Transparency log

Security for bipolar-explorer-mne 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for bipolar_explorer_mne-0.1.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 26, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page