Awesome Open Source
Awesome Open Source

EEGEdu

MIT license PRs welcome! issues

Interactive Brain Playground Logo

EEGEdu is an Interactive Brain Playground.

EEGEdu is served live at https://eegedu.com/. This website is served from the software in this repository. So, all you need to do to try the system out is head to EEGEdu.

EEGEdu is designed as an interactive educational website to learn/teach about working with electroencephalogram (EEG) data. It is a teaching tool that allows for students to interact with their own brain waves.

EEGEdu has been inspired by multiple works that came before. It is inspired by EEG101, but EEGEdu is web-based. Being web-based allows students to interact with EEG brain data without having to install any software. Others have used Neurotech EEG-notebooks in python for data collection and analysis with muse-lsl. These software support the Interaxon MUSE headset but require a bluetooth low-energey (BLE) dongle to work with common operating systems (e.g. Windows or Mac OSX). These tools also required the editing pyglatt code to connect to Muse headsets. Thus, previous software are cumbersome and serve as a barrier to entry for many students learning about EEG. EEGEdu aims to provide students with an accesible introduction to working with their own brain waves.

EEGEdu Curriculum

EEGEdu provides an step-by-step incremental tutorial for students to interact with EEG-based brain signals. So, we break down the curriculum into 10 lessons as follows:

  1. Connect + hardware, Biophysics + signal viewing
  2. Heart rate time domain data
  3. Heart rate frequency domain -beats per minute
  4. Raw Data + artifacts + blinks + record
  5. Frequency domain explanation + Raw spectra + record
  6. Frequency bands + record
  7. Spectrogram
  8. Neurofeedback p5js demos
  9. Eyes closed eyes open experiment
  10. SSVEP experiment
  11. BCI trainer

Installation for Development

If you are interested in developing EEGEdu, here are some instructions to get the software running on your system. Note: Currently EEGEdu development requires a Mac OSX operating system.

To start, you will need to install Homebrew and yarn. These are easy to install with the following Terminal / bash commands:

## Install homebrew
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

## Install yarn
# NOTE: this will also install Node.js if it is not already installed.
brew install yarn 

# NOTE: Node.js must be version 10.x for Muse interaction

# Thus, if you are getting version issues, install n, with the following command:
# sudo npm install -g n

# Then, you can switch to version 10.x with the following command:
# sudo n 10.16.0

Then, in Terminal/bash, clone this Git repository and change directory into the newly cloned folder:

git clone https://github.com/kylemath/EEGEdu
cd EEGEdu

Then, you can install the required yarn packages for EEGEdu:

yarn install

Local Development Environment

Then, you can run the Local Development Environment of EEGEdu:

yarn start dev

If it is working correctly, the EEGEdu application will automatically open in a browser window at http://localhost:3000.

Local Production Environment

To start the Local Production Environment, you can use the following commands:

yarn cache clean
yarn run build
serve -s build

Local Testing of Changes

  1. Install any new packages yarn install
  2. Start the Local Development Environment yarn start dev
  3. Look for errors in terminal log
  4. Open's browser to http://localhost:3000
  5. Open Javascript console
  6. Look for errors in console
  7. Connect Mock data stream by clicking Connect button
  8. Run through the checkFunction below with Mock data.
  9. Disconnect Mock data stream
  10. Turn on Interaxon Muse headband
  11. Connect Muse data stream
  12. Repeat the checkFunction below with Muse data.
# Pseudocode for checking EEGEdu functionality
checkFunction = {
    view raw data 
    change sliders 
    make sure data changes and no errors
    click spectra
    move sliders
    make sure changes
    click bands
    move sliders
    make sure changes
}

Deployment

EEGEdu is running on Firebase and deployment happens automagically using GitHub post-commit hooks, or Actions, as they are commonly called. You can see how the application is build and deployed by inspecting the workflow.

Currently this automagic deployment is not working, so we can deploy to firebase manually:

First, install the Firebase deployment tools:

sudo brew install firebase
sudo yarn global add firebase-tools
sudo yarn global add firebase

The first deployment requires login and initialization once:

firebase login

Browser opens, and login to Google account authorized for Firebase deployment:

firebase init
  • options: Hosting Sites only
  • public directory: build
  • single-page app: No
  • Overwrite - No
  • Overwrite - No

Then, deployment to Firebase happens with the following commands:

# clean the local cache to ensure most recent version is served
yarn cache clean

# build the latest version of the site
yarn run build

# deploy the latest version to firebase
firebase deploy

References and Related Tools

Contributing

The guide for contributors can be found here. It covers everything you need to know to start contributing to EEGEdu.

Credits

EEGEdu - An Interactive Electrophysiology Tutorial with the Interaxon Muse brought to you by Mathewson Sons. A KyKorKey Production.

License

EEGEdu is licensed under The MIT License (MIT)



Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Js (1,059,387
Javascript (1,059,387
Deployment (57,638
Firebase (21,024
Data Visualization (5,666
Data Analysis (4,802
Plotting (2,981
Eeg (1,640
Ecg (158
Bci (108
Eeg Data (45
Frequency Domain (40
Muse (38
Neuroscience Methods (37
Openbci (23
Brain Waves (14
Neurotech (8
Muse Headset (4