A Pipeline-GUI for MNE-Python from MEG-Lab Heidelberg
Project description
mne-pipeline-hd
A Pipeline-GUI for MNE-Python from MEG-Lab Heidelberg
Installation
- Install MNE-python as instructed on the website
- Then run
pip install https://github.com/marsipu/mne-pipeline-hd/zipball/main
in the conda-enviroment you created in step 1 for MNE-Python.
Update
Run pip install --upgrade --no-deps --force-reinstall https://github.com/marsipu/mne-pipeline-hd/zipball/main
for an update to the development version
or pip install --upgrade mne-pipeline-hd
for the latest release.
Start
Run mne_pipeline_hd
in your conda-environment where you installed mne-python and mne-pipeline-hd.
or
run __main__.py from the terminal or an IDE like PyCharm, VSCode, Atom, etc.
When using the pipeline and its functions bear in mind that the pipeline is still in development! The basic functions supplied are just a suggestion and you should verify before usage if they do what you need. They are also partly still adjusted to specific requirements which may not apply to all data.
Bug-Report/Feature-Request
Please report bugs on GitHub as an issue or to me (dev@mgschulz.de) directly. And if you got ideas on how to improve the pipeline or some feature-requests, you are welcome to open an issue too or send an e-mail (dev@mgschulz.de)
Contribute and build your own functions/fix bugs
I you want to help by contributing, I would be very happy:
You need a GitHub-Account and should have git installed.
- Fork this repository on GitHub
- Move to the folder where you want to clone to
- Clone your forked repository with git from a
terminal:
git clone <url you get from the green clone-button from your forked repository on GitHub>
- Add upstream to git for
updates:
git remote add upstream git://github.com/marsipu/mne-pipeline-hd.git
- Install development version with pip:
pip install -e .[tests]
- Install the pre-commit hooks with:
pre-commit install
- Create a branch for changes:
git checkout -b <branch-name>
- Commit changes:
git commit -am "<your commit message>"
- Push changes to your forked repository on GitHub:
git push
- Make "New pull request" from your new feature branch
You can always write me an e-mail, if you have questions about the contribution-process or about the program-structure.
Acknowledgments
This Pipeline is build on top of MNE-Python
A. Gramfort, M. Luessi, E. Larson, D. Engemann, D. Strohmeier, C. Brodbeck, L. Parkkonen, M. Hämäläinen, MNE software for processing MEG and EEG data, NeuroImage, Volume 86, 1 February 2014, Pages 446-460, ISSN 1053-8119, DOI
It was inspired by a pipeline from Lau M. Andersen
Andersen LM. Group Analysis in MNE-Python of Evoked Responses from a Tactile Stimulation Paradigm: A Pipeline for Reproducibility at Every Step of Processing, Going from Individual Sensor Space Representations to an across-Group Source Space Representation. Front Neurosci. 2018 Jan 22;12:6. doi: 10.3389/fnins.2018.00006. PMID: 29403349; PMCID: PMC5786561.
This program also integrates autoreject
Mainak Jas, Denis Engemann, Yousra Bekhti, Federico Raimondo, and Alexandre Gramfort. 2017. “Autoreject: Automated artifact rejection for MEG and EEG data”. NeuroImage, 159, 417-429.
Many ideas and basics for GUI-Programming where taken from LearnPyQt and numerous stackoverflow-questions/solutions.
The development is financially supported by Heidelberg University.
Thank you to the members of my laboratory (especially my supervisor Andre Rupp) for their feedback and testing in the early stages of development.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mne_pipeline_hd-0.3.3a0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 558151e5c64140353f19a69b725ac08656a79ebf435a8672664fff258a37a48f |
|
MD5 | ccc0851e3b282923109ed937a7e80de5 |
|
BLAKE2b-256 | c0d9072414f3f80ef7f2a62a9d246acfd9473121d51ec8a91b3b2387f672e9f2 |
Hashes for mne_pipeline_hd-0.3.3a0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7650c477f6e61169eb8cd02ad6efb73587f0e085837f4c201451cfed8c112525 |
|
MD5 | d376fed27dad616c7f14bf6a525f4ade |
|
BLAKE2b-256 | edf78b581a0bbb9e47917ac6c1e9586bc497606ab2cc4ea5ddd124c8d5189979 |