/meggie

User-friendly MNE-python based graphical user interface to do M/EEG analysis with multiple subjects

Primary LanguagePythonOtherNOASSERTION

Guide to the most basic things in Meggie

Installation

Suggested way to install meggie is to first install MNE-python with all its dependencies to python environment, and then install meggie to that same environment. Here's one way to do this in Unix with the help of anaconda distribution:

  1. Create new python environment: conda create -n meggie-env python=3
  2. Activate the environment using: conda activate meggie-env
  3. Install mne to environment: conda install -c conda-forge mne
  4. Clone or download this repository and go inside.
  5. Install meggie to the environment using: python setup.py install
  6. Run Meggie with command: meggie

Note that installing MNE-python with "pip install mne" does not install dependencies. If you don't want to use conda-forge channel for MNE-python installation, please consult https://www.martinos.org/mne/stable/install_mne_python.html for official instructions.

Meggie can be installed directly using conda too:

  1. Create environment: conda create -n meggie-env python=3
  2. Activate environment: conda activate meggie-env
  3. Install meggie: conda install -c conda-forge -c cibr meggie
  4. Run meggie with: meggie

Given that we routinely release conda packages, meggie can even be installed with no Terminal what so ever if in Windows:

  1. Download Anaconda 3 and install it.
  2. Open Anaconda Navigator from Start menu.
  3. Add channels cibr and conda-forge to channels list.
  4. Go to Environments tab, and create environment called meggie-env and initialize it with Python 3.x
  5. Go to Home tab again and select meggie-env from the environments list at the top.
  6. Meggie icon should appear in the main view. Click install.
  7. And then launch.

Debugging

  • If command meggie is not found, you should ensure that you are in the correct python environment.
  • If the command is found, but the software crashes during startup to an ImportError, you should ensure that you are using Python 3 and that the dependencies are installed. Individual missing dependencies can often be installed with either conda install or pip install.
  • If the software crashes during analysis, and the terminal window does not show you the stack trace, you may start meggie using command meggie debug and reproduce the crash with stacktrace.

License

This project is licensed under the BSD license.

Acknowledgements

Great thanks to the excellent MNE-python.