Skip to main content

EEGIO: An io package for eeg data that is MNE-Python and MNE-BIDS compatible .

Project description


Build Status Coverage Status Code style: black GitHub PyPI GitHub last commit GitHub repo size

For an easy-to-use API interfacing with EEG data in EDF, or FIF format in the BIDS-EEG layout. This module stores the code for IO of EEG data for human patients, and pipelining code to convert clinical center data (i.e. time series eeg, clinical metadata) into a developer-friendly dataset that is also invertible and debug-friendly.


  • Add support for adding structural context via neuroimaging processed data (e.g. FreeSurfer)

Installation Guide

EEGio is intended to be a lightweight wrapper for easily analyzing large batches of patients with EEG data. eegio relies on the following libraries to work:

pyedflib (deprecated)
xlrd (deprecated)


Intended Users / Usage

Epilepsy researchers dealing with EEG data compliant with BIDS and MNE formats. Anyone with human patient EEG data.
See example and docs for info on how to format this.

Setting Up the BIDS Directory and Reading EEG Data From EDF/FiF

These are just lightweight wrappers of MNE/pyedflib reading to load in EDF/FiF data easily, so that raw EEG ts are readily accessible in Python friendly format. We provide an example that was built off of the examples in MNE-BIDS. See example.

For more info, see tutorials and documentation.


We welcome contributions from anyone. Please view our contribution guidelines. Our issues page is a great place for suggestions! If you have an idea for an improvement not listed there, please make an issue first so you can discuss with the developers. For information on setting up testing, see testing guide.


This project is covered under the GNU GPL 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

eegio-0.1.3.tar.gz (63.4 kB view hashes)

Uploaded source

Built Distribution

eegio-0.1.3-py3-none-any.whl (68.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page