engageub/BrainWaves

An easy-to-use platform for EEG experimentation in the classroom

An easy-to-use platform for EEG experimentation in the classroom

Features

• Design, run, and analyze an experiment using real EEG data all in one desktop app
• Investigate visual event-related brain waves (ERPs)
• Supports Emotiv Epoc+ and Muse devices

Screenshots

Prerequisites

BrainWaves is an Electron app that can be installed natively on your system. However, because it makes use of the MNE Python library to perform EEG analysis, it is necessary to set up an appropriate Python environment to be able to analyze collected experimental results.

Environment Setup

BrainWaves needs an Anaconda environment called "brainwaves" with the right dependencies to run its analysis.

1. Download and install Anaconda for Python 3. We recommend using the Miniconda installer for Python 3.7 available from this page. When installing, select the option to "Add Anaconda to my PATH environment variable".

2. Download the BrainWaves environment file or grab it by cloning this repository

Note: you may need to install Microsoft Visual C++ Build Tools to run this following command on Windows

3. Open Anaconda prompt (or terminal on Linux and OSX) in the directory where the environment file is located and run conda env create -f environment.yml

4. If the environment is created successfully, activate the new conda environment that is created with conda activate brainwaves

5. Finally, run the following command to create a new jupyter kernel that uses this environment: python -m ipykernel install --user --name brainwaves --display-name "brainwaves"

Download

• Windows: click here
• MacOS: coming soon
• Linux (only supports Muse): click here

Installing from Source (for developers)

• Make sure you have node version >= 7, npm version >= 4 and have followed the Environment Setup instructions

OS X

• may need to update your .bash_profile to include the path for your compiler (nothing terribly scary).
  1. Find it's location

  which gcc

  2. Add this path to your .bash_profile

  export PATH="/usr/bin:$PATH"

Windows 10

• Visual C++ Build Tools

1. First, clone the repo via git:

git clone https://github.com/makebrainwaves/BrainWaves.git

2. And then install dependencies

$ cd BrainWaves
$ npm install

3. If using Emotiv, insert your Emotiv account's credentials into the file keys.js

Run

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

$ npm run dev

Alternatively, you can run the renderer and main processes separately. This way, you can restart one process without waiting for the other. Run these two commands simultaneously in different console tabs:

$ npm run start-renderer-dev
$ npm run start-main-dev

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

To run End-to-End Test

$ npm run build
$ npm run test-e2e

💡 You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:

DEBUG_PROD=true npm run package

Contributing

if you are interested in fixing issues with the BrainWaves app or helping us add additional features, that's amazing! Please see our How to Contribute.

Also, read our Code of Conduct

License

MIT