Python tools associated with Muse headband
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

pyMuse

This repository contains tools for gathering and processing Muse signals using Python.

Installation & dependences

You will need a few tools to get started with the Muse headset and pyMuse:

Do not hesitate to visit the Muse Developer website for additional information.

Installation of this package

Ensure you have downloaded the correct Python distribution and the pyMuse package (e.g., using git clone).

Open a terminal, go into the package and type:

pip install -r requirements.txt.

The installer should install all requirements, including:

  • numpy
  • scipy
  • matplotlib
  • pyosc

Getting started on Windows

Display your Muse data with eeg displayer

  1. Connect your Muse headset with your computer by bluetooth

  2. Start Muse Direct and set an OSC UDP output

Set OSC/UDP output on localhost:5001

Ensure all output data and all output algorithm are selected.

  1. Start EEG display script (in a new terminal):
python eeg_display.py

Save Muse data and stream offline

See the developer webpage for details.

  1. Connect your Muse headset with your computer by bluetooth

  2. Start Muse Direct and set a Save to File output:

You must create a save to file output

  1. Press the record button when you want to begin recording your brain waves. Stop recording when you are done.

Press Record

  1. Run MusePlayer to stream the data to a server.
muse-player -f MyExperiment.muse -s osc.udp://localhost:5001

Note that you can add your recorded data to the following repository to share it with the other members.

  1. Now you can display your recorded session using eeg displayer, or processing with your favorite software.

Getting started on MacOS/Linux

Display your Muse data with eeg displayer

  1. Connect your Muse headset with your computer by bluetooth

  2. Start Muse IO and set an OSC UDP output:

muse-io --device Muse-XXXX --osc osc.udp://localhost:5001

  1. Start the EEG display script (in a new terminal):

python eeg_display.py

Save Muse data and stream offline

See the developer webpage for details.

  1. Connect your Muse headset with your computer by bluetooth

  2. Start Muse IO and set an OSC UDP output:

muse-io --device Muse-XXXX --osc osc.udp://localhost:5001

  1. Save that stream to a file with MuseLab

  2. Run MusePlayer to stream the data to a server.

muse-player -f MyExperiment.muse -s osc.udp://localhost:5001

Note that you can add your recorded data to the following repository to share it with the other members.

  1. Now you can display your recorded session using eeg displayer, or processing with your favorite software.