eeg-notebooks: a Python library for mobile EEG experiments and analysis

[JohnGriffiths]

Project info

Title:
eeg-notebooks: a Python library for mobile EEG experiments and analysis

Project lead:

• John Griffiths
• Twitter: @neurodidact
• Brainhack mattermost (+ NeuroTechX slack): @JohnGrif

Project collaborators:
eeg-notebooks is one of the many fruits of the NeuroTechX global neurotechnology hacker community. There's a long list of past and present contributors to the project. Currently active contributors include John Griffiths, Jadin Tredup, Morgan Hough, Cristiano Micheli, Kyle Mathewson, and several others .

Please add your name to the list here if you're interested in contributing eeg-notebooks during the BrainHack Global 2020 sprint, and/or thereafter.

Registered Brainhack Global 2020 Event:
The main BHG2020 eegnb sprint will happen during Brainhack Ontario (2-4th Dec).

...but we are expecting to have contributors from around the world in multiple time zones during this time :)

Project Description:

eeg-notebooks is a Python library that allows you to run cognitive neuroscience experiments with a simple mobile EEG device and laptop computer. We like to think of and talk about this as "democratizing the cognitive neuroscience experiment", because it makes it possible to achieve for a few hundred bucks what traditionally has only been possible in dedicated research labs with quadruple figure price tags.

Examples:

Launch experiment and device selection prompt with the stand-alone command line interface:

eegnb runexp -ip 

Run a visual N170 (faces vs. houses) RSVP EEG experiment via the Python API:

from eegnb.experiments.visual_n170 import n170   # choose and import the experiment to run from a wide selection
from eegnb.devices.eeg import EEG                # import and initialize an EEG object that deals with 
eeg_device = EEG(device='muse2016')              # ...connecting to and streaming from your device
n170.present(duration=300, eeg=eeg_device,       # launch the experiment (psychopy visual stimulus presentation), 
                     save_fn='my170data.csv')    # ...and write EEG data and experiment triggers to file

For more examples, check out the sphinx examples gallery.

Data to use:

1. The eeg-notebooks repo has multiple example datasets for several EEG experiments. We are very interested in contributions that present compelling new analyses of these data in the examples documentation

2. Collect your own data! We are compiling a large database of user-contributed EEG data, collected using the eeg-notebooks visual and auditory experiments.

Link to project repository/sources:
https://github.com/NeuroTechX/eeg-notebooks
Docs page: https://neurotechx.github.io/eeg-notebooks

Goals for Brainhack Global 2020:

At BHG 2020 we are primarily looking for contributions in the following areas

• Extend and fill gaps in the documentation
• New analyses of existing data (ERPs, SSVEPs)
• Add new experiments in PsychoPy
• Generate EEG/ERP recordings for our database
• Add support for new devices
• Test support for existing devices

We're also all ears for any cool new additional functionality ideas.

Important point: You don't need an EEG device available to join us and make contributions.

For example, there's plenty of important work to be done that is straight-up MNE, and/or Scikit-Learn, and/or Psychopy.

You can contribute to data collection and device testing if you have access to one or more of the following: Muse2016, Muse2, MuseS, OpenBCI Ganglion, OpenBCI Cyton, G.Tec Unicorn, BrainBit, Neurosity Notion 1, Neurosity Notion 2. See the eeg-notebooks documentation for more info.

Good first issues:

1. Test installation, report any bugs + observations for improvement in docs (more here )

2. Run the visual N170 experiment and compute ERPs (more here)

See more good first issues here

Skills:

Essential:

• Python

Or

• A keen interest in EEG and in writing and editing documentation

Useful, depending on what you do:

• MNE
• Scikit-Learn
• PsychoPy
• EEG analysis and interpretation
• Behavioural experiment design and programming
• Documentation writing

Tools/Software/Methods to Use:

See the installation instructions . Please work through these prior to 2nd Dec, and post any issues you have in getting set up on the github repo issues page.

Communication channels:

Project labels

• I added all of the labels I want an associate to my project

Project Submission

Submission checklist

Once the issue is submitted, please check items in this list as you add under ‘Additional project info’

• Link to your project: could be a code repository, a shared document, etc.
• Goals for Brainhack Global 2020: describe what you want to achieve during this brainhack.
• Flesh out at least 2 “good first issues”: those are tasks that do not require any prior knowledge about your project, could be defined as issues in a GitHub repository, or in a shared document.
• Skills: list skills that would be particularly suitable for your project. We ask you to include at least one non-coding skill. Use the issue labels for this purpose.

Optionally, you can also include information about:

• Number of participants required.
• Twitter-sized summary of your project pitch.
• Provide an image of your project for the Brainhack Global 2020 website.

We would like to think about how you will credit and onboard new members to your project. If you’d like to share your thoughts with future project participants, you can include information about:

• Specify how you will acknowledge contributions (e.g. listing members on a contributing page).
• Provide links to onboarding documents if you have some:

[complexbrains]

Hi @JohnGriffiths Welcome among us! Thank you so much or your project submission 🎉 It is really exciting to see an EEG project get going as an EEG enthusiast myself!

It seems like we are missing several details for regarding

• goals that you want to achieve through the Branhack
• a couple of issues that you might list as the starting point to be addressed through the event
• the rough skill sets that you require from your attendees (if you do not require any, it would be really useful to indicate it there too)
• and any prerequisite from your project attendees you would like them to come ready with.
• and add project-related labels by following the instruction at the issue template.

We also recommend projects to have their own Mattermost discussion channels for easy communication.

If you could fill those details before the event please, that would be really helpful to have for attendees to find out whether their interests and skillsets fit with your project scopes and requisites. Once you complete those listed details, we will approve the issue and it will be showcased at the Brainhack Global 2020 website.

Please do let us know if you would need any help from us in the meantime.

Hope you enjoy the Brainhack Global 2020!

[JohnGriffiths]

Thanks - filling in the missing deets imminently.