Skip to main content

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

Project description

EEG IO

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.

TODO

  • 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:

numpy
scipy
scikit-learn
pandas
mne
mne-bids
pybids
seaborn
matplotlib
pyedflib (deprecated)
xlrd (deprecated)

See INSTALLATION GUIDE

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.

Contributing

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.

License

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file eegio-0.1.3.tar.gz.

File metadata

  • Download URL: eegio-0.1.3.tar.gz
  • Upload date:
  • Size: 63.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

File hashes

Hashes for eegio-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1f392d11fd7f3a1276cce0bc4762d47aa16f731cae41962f543566fa3b008dff
MD5 cd2ae243de1b29f2449314a1deb2fd7f
BLAKE2b-256 078515b798e7390793bea7144b76bd8ef545b7cfead95b4d9b65e1a56d2c2d06

See more details on using hashes here.

File details

Details for the file eegio-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: eegio-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 68.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

File hashes

Hashes for eegio-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a56eeb5a21d8fafc1d01e89ac2fd955bfb6486b11ce320e93418edaa86e824a6
MD5 ed065abfada8d1943d60822a52fe1d37
BLAKE2b-256 76575a1c0780744222b2287ae1731b45e120cc39bab84b02cad37829876cd9e6

See more details on using hashes here.

Supported by

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