Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add new mne python module #193

Merged
merged 6 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/en/modules/mne_python/brain_dynamics.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/modules/mne_python/brain_dynamics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
95 changes: 95 additions & 0 deletions content/en/modules/mne_python/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
type: "modules" # DON'T TOUCH THIS ! :)

# Title of your project (we like creative title)
title: "Working with MNE-Python and EEG-BIDS"

# Your project GitHub repository URL
github_repo:

# If you are working on a project that has website, indicate the full url including "https://" below or leave it empty.
website:

# List +- 4 keywords that best describe your project within []. Note that the project summary also involves a number of key words. Those are listed on top of the [github repository](https://github.com/PSY6983-2021/project_template), click `manage topics`.
# Please only lowercase letters
tags: [MNE, python, EEG, BIDS, brain dynamics]

# Summarize your project in < ~75 words. This description will appear at the top of your page and on the list page with other projects..

summary: "This repo includes tutorial for Working with MNE-Python and EEG-BIDS."

# If you want to add a cover image (listpage and image in the right), add it to your directory and indicate the name
# below with the extension.
image: "brain_dynamics.gif"
---
<!-- This is an html comment and this won't appear in the rendered page. You are now editing the "content" area, the core of your description. Everything that you can do in markdown is allowed below. We added a couple of comments to guide your through documenting your progress. -->

## Information

The estimated time to complete this training module is 2.30h.

The prerequisites to take this module are:
* Installations
* [Working with MNE-Python and EEG-BIDS](https://psy6983.brainhackmtl.org/modules/mne_python/) module.

Contact Davide Momi if you have questions on this module, or if you want to check that you completed successfully all the exercises.


## Resources
This module was presented by Davide Momi during the [Brainhack Toronto](https://brainhackto.github.io/global-toronto-12-2022/), and the associated notebooks are available [here](https://github.com/Davi1990/mne_eeg_workshop)

The video of the presentation is available below (1h33):
<iframe width="560" height="315" src="https://www.youtube.com/embed/du1XezR246w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

## Tutorial
To run the code locally please follow the instructions
* Download the folder using:
```
git clone https://github.com/Davi1990/mne_eeg_workshop/
```

* Install the required dependencies using:
```
pip install -r requirements.txt
```

* Download the required data folder at: https://drive.google.com/drive/folders/1DO-dXfIXzGDzmgcWRMtYvX30ZECYzRYd?usp=sharing

* Download the raw file at: https://drive.google.com/file/d/1-RSyaXp2Chx0zLuaAnlgK8o1VMo3enx8/view?usp=share_link

* Start a new jupyter notebook
* Watch the video and run the cells in the notebook
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Watch the video and run the cells in the notebook
* Watch the video and run the cells in the notebook


## Exercise

1. **Read through the notebook running all the cells**
2. **Complete the exercises in the notebook**

**Exercise 1** Check information of the MNE-BIDS file that was saved as part of Tutorial 01.

How many channels do you have for each type of sensors?
What is the sampling frequency?
Have the data been filtered?
What is the frequency of the line noise?
Is there any bad channel?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block might not render correctly. Please build the page locally and double check.


**Exercise 2** Import a new epoched file and generating Figure of both evoked response and principal components

Read the file 'sub-s01_task-faceFO_eeg.fif' as an epoched object
Make a joint plot of the time-series?
Create a variable with the array of the evoked data
Decompose the data using SVD (use the function numpy.linalg.svd)
Make a matplotlib figure with 1 row and 5 columns and plot the first 5 components using the function mne.viz.plot_topomap
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block might not render correctly. Please build the page locally and double check.



* Follow up with Natasha Clarke to validate you completed the exercise correctly.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to change the name...

* :tada: :tada: :tada: you completed this training module! :tada: :tada: :tada:


## More resources

- Other great resources to get started with plotting in python:
- [MNE-Python](https://mne.tools/stable/auto_tutorials/index.html)
- [Neurodesk](https://www.neurodesk.org/tutorials/electrophysiology/eeg_mne-python/)

<iframe width="560" height="315" src="https://www.youtube.com/embed/MYcCRhEb5Ic" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>