Metadata-Version: 2.5
Name: eeglabio
Version: 0.1.4
Summary: I/O support for EEGLAB files in Python
Project-URL: Homepage, https://github.com/jackz314/eeglabio
Project-URL: Documentation, https://eeglabio.readthedocs.io
Project-URL: Source, https://github.com/jackz314/eeglabio
Project-URL: Tracker, https://github.com/jackz314/eeglabio/issues
Author-email: Jack Zhang <zhangmengyu10@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: EEG,EEGLAB,MEG,MNE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: numpy
Requires-Dist: scipy
Description-Content-Type: text/markdown

# eeglabio [![Documentation Status](https://readthedocs.org/projects/eeglabio/badge/?version=latest)](https://eeglabio.readthedocs.io/en/latest/?badge=latest) [![Test & Publish](https://github.com/jackz314/eeglabio/actions/workflows/test_publish.yml/badge.svg)](https://github.com/jackz314/eeglabio/actions/workflows/test_publish.yml) [![PyPI version](https://badge.fury.io/py/eeglabio.svg)](https://badge.fury.io/py/eeglabio) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/eeglabio.svg)](https://anaconda.org/conda-forge/eeglabio)

I/O support for EEGLAB files in Python.

### Installation

Install from [PyPI](https://pypi.org/project/eeglabio):

```shell
pip install eeglabio
```

Install from [Test PyPI](https://test.pypi.org/project/eeglabio) (built from 
[stable](https://github.com/jackz314/eeglabio/tree/stable) branch):

```shell
pip install -i https://test.pypi.org/simple/ eeglabio
```

Install from [conda-forge](https://github.com/conda-forge/eeglabio-feedstock):

```shell
conda install -c conda-forge eeglabio
```

Install the latest version of the code from GitHub directly (unstable):

```shell
pip install https://github.com/jackz314/eeglabio/archive/main.zip
```

### Dependencies

eeglabio requires Python >= 3.10 and the following packages:

* [numpy](http://numpy.org/)
* [scipy](https://www.scipy.org/)

Exporting to the MATLAB v7.3 (HDF5) format, needed for 2 GB or more of data,
also requires [h5py](https://www.h5py.org).

For testing, we also require the following additional packages:

* [mne](https://github.com/mne-tools/mne-python)


### Example Usage (with [MNE](https://github.com/mne-tools/mne-python))

Export from MNE [`Epochs`](https://mne.tools/stable/generated/mne.Epochs.html) to EEGLAB (`.set`):

```python
import mne
from eeglabio.utils import export_mne_epochs
epochs = mne.Epochs(...)
export_mne_epochs(epochs, "file_name.set")
```

Export from MNE [`Raw`](https://mne.tools/stable/generated/mne.io.Raw.html) to EEGLAB (`.set`):

```python
import mne
from eeglabio.utils import export_mne_raw
raw = mne.io.read_raw(...)
export_mne_raw(raw, "file_name.set")
```
