Metadata-Version: 2.1
Name: mnelab
Version: 0.6.2
Summary: A graphical user interface for MNE
Home-page: https://github.com/cbrnr/mnelab
Author: Clemens Brunner
Author-email: clemens.brunner@gmail.com
License: BSD-3-Clause
Keywords: EEG MEG MNE GUI electrophysiology
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: mne (>=0.21.0)
Requires-Dist: QtPy (>=1.9.0)
Requires-Dist: numpy (>=1.14.0)
Requires-Dist: scipy (>=1.0.0)
Requires-Dist: matplotlib (>=2.1.0)
Requires-Dist: pyobjc-framework-Cocoa (>=5.2.0) ; platform_system == "Darwin"
Provides-Extra: brainvision
Requires-Dist: pybv ; extra == 'brainvision'
Provides-Extra: edf
Requires-Dist: pyEDFlib ; extra == 'edf'
Provides-Extra: fastica
Requires-Dist: scikit-learn ; extra == 'fastica'
Provides-Extra: picard
Requires-Dist: python-picard ; extra == 'picard'
Provides-Extra: xdf
Requires-Dist: pyxdf ; extra == 'xdf'

[![PyPI Version](https://img.shields.io/pypi/v/mnelab)](https://pypi.org/project/mnelab/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/mnelab)](https://anaconda.org/conda-forge/mnelab)
![Python](https://img.shields.io/badge/python-3.6&ndash;3.8-green.svg)
![Downloads PyPI](https://img.shields.io/pypi/dm/mnelab?color=blue&label=downloads%20pypi)
![Downloads Conda](https://img.shields.io/conda/dn/conda-forge/mnelab?color=blue&label=downloads%20conda)
![License](https://img.shields.io/github/license/cbrnr/mnelab)

![](https://raw.githubusercontent.com/cbrnr/mnelab/master/mnelab/images/mnelab_logo.png)

Graphical user interface (GUI) for [MNE](https://github.com/mne-tools/mne-python), a Python-based toolbox for EEG/MEG analysis.

![](https://raw.githubusercontent.com/cbrnr/mnelab/master/mnelab.png)

### Changelog
Check out the [changelog](https://github.com/cbrnr/mnelab/blob/master/CHANGELOG.md) to learn what we added, changed or fixed in the latest version.

### Dependencies
MNELAB requires Python >= 3.6. In addition, the following Python packages are required:
- [QtPy](https://github.com/spyder-ide/qtpy) >= 1.9.0
- [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5) >= 5.10.0 or [PySide2](https://www.qt.io/qt-for-python) >= 5.10.0
- [numpy](http://www.numpy.org/) >= 1.14.0
- [scipy](https://www.scipy.org/scipylib/index.html) >= 1.0.0
- [matplotlib](https://matplotlib.org/) >= 2.1.0
- [mne](https://github.com/mne-tools/mne-python) >= 0.21.0
- [pyobjc-framework-Cocoa](https://pyobjc.readthedocs.io/en/latest/) >= 5.2.0 (macOS only)
- python.app (only when using Anaconda or Miniconda Python on macOS)

Optional dependencies provide additional features if installed:
- [scikit-learn]() (ICA computation with FastICA)
- [python-picard](https://pierreablin.github.io/picard/) (ICA computation with PICARD)
- [pyxdf](https://github.com/xdf-modules/xdf-Python) (import XDF)
- [pyEDFlib](https://github.com/holgern/pyedflib) (export to EDF/BDF)
- [pybv](https://github.com/bids-standard/pybv) (export to BrainVision VHDR/VMRK/EEG)

### Additional features
MNELAB comes with the following features that are not (yet) available in MNE:
- Export to EDF/BDF (requires [pyEDFlib](https://github.com/holgern/pyedflib))
- Export to EEGLAB SET
- Export to BrainVision VHDR/VMRK/EEG (requires [pybv](https://github.com/bids-standard/pybv))
- Import [XDF](https://github.com/sccn/xdf/wiki/Specifications) files (requires [pyxdf](https://github.com/xdf-modules/xdf-Python))

### Installation
#### pip
1. Install either PyQt5 (`python3 -m pip install PyQt5`) or PySide2 (`python3 -m pip install PySide2`).
2. Install MNELAB (`python3 -m pip install mnelab`).

You can start MNELAB in a terminal with `mnelab` or `python3 -m mnelab`.

#### conda
An (unofficial, but regularly updated) conda package can be installed from [conda-forge](https://conda-forge.org/).
We strongly suggest to install MNELAB into its own dedicated environment to ensure smooth installation and operation:

```
conda create -y -n mnelab -c conda-forge mnelab
```

You can start MNELAB in a terminal with `conda activate mnelab` followed by `mnelab` or `python -m mnelab`. Any issues with this conda package should be reported to the respective [issue tracker](https://github.com/conda-forge/mnelab-feedstock/issues).

#### Arch Linux
If you use [Arch Linux](https://www.archlinux.org/), you can install the [python-mnelab](https://aur.archlinux.org/packages/python-mnelab/) AUR package (note that this requires the [python-mne](https://aur.archlinux.org/packages/python-mne/) AUR package).

#### Standalone installer
A stand-alone installer will be available soon.

#### Development version
Follow these steps to use the latest development version of MNELAB:

1. [Download the source code](https://github.com/cbrnr/mnelab/archive/master.zip) and unpack it into a folder of your choice.
2. Install all dependencies listed above.
3. Run `python3 -m mnelab` to start MNELAB (if this does not work try `python -m mnelab`, just make sure to use Python 3 because Python 2 is not supported).

### Contributing
The [contributing guide](https://github.com/cbrnr/mnelab/blob/master/CONTRIBUTING.md) contains detailed instructions on how to contribute to MNELAB.


