An easy-to-use platform for EEG experimentation in the classroom
- 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
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.
BrainWaves needs an Anaconda environment called "brainwaves" with the right dependencies to run its analysis.
- Download and install Anaconda for Python 3. We recommend using the Miniconda installer for Python 3.6 available from this page https://github.com/makebrainwaves/BrainWaves
- 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
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
If the environment is created successfully, run the following command to create a new jupyter kernel that uses this environment:
python -m ipykernel install --user --name brainwaves --display-name "brainwaves"
Installing from Source (for developers)
- Make sure you have node version >= 7, npm version >= 4 and have followed the Environment Setup instructions
- may need to update your
.bash_profileto include the path for your compiler (nothing terribly scary).
- Find it's location
- Add this path to your
- First, clone the repo via git:
git clone https://github.com/makebrainwaves/BrainWaves.git
- And then install dependencies
$ cd BrainWaves $ npm install
- If using Emotiv, insert your Emotiv account's credentials into the file
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
To package apps for the local platform:
$ npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
$ 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
DEBUG_PROD env variable:
DEBUG_PROD=true npm run package
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