Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] add badges and conda-forge install instructions #7

Merged
merged 1 commit into from
Aug 3, 2022
Merged

[DOC] add badges and conda-forge install instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,49 @@
# 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)
# 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) (unreleased):

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

Install the latest version of the code from GitHub directly (unstable):
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.6 and the following packages:

* [numpy](http://numpy.org/)
* [scipy](https://www.scipy.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
Expand All @@ -43,6 +52,7 @@ 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
Expand Down