The Hyperscanning Python Pipeline.
Project description
HyPyP 🐍〰️🐍
The Hyperscanning Python Pipeline
Contributors
Florence BRUN, Anaël AYROLLES, Phoebe CHEN, Amir DJALOVSKI, Yann BEAUXIS, Suzanne DIKKER, Guillaume DUMAS
Installation
pip install HyPyP
Documentation
HyPyP documentation of all the API functions is available online at hypyp.readthedocs.io
For getting started with HyPyP, we have designed a little walkthrough: getting_started.ipynb
API
🛠 io.py — Loaders (Florence, Anaël, Guillaume)
🧰 utils.py — Basic tools (Amir, Florence, Guilaume)
⚙️ prep.py — Preprocessing (ICA & AutoReject) (Anaël, Florence, Guillaume)
🔠 analyses.py — Power spectral density and wide choice of connectivity measures (Phoebe, Suzanne, Florence, Guillaume)
📈 stats.py — Statistics (permutations & cluster statistics) (Florence, Guillaume)
🧠 viz.py — Inter-brain visualization (Anaël, Amir, Florence, Guillaume)
🎓 Tutorials - Examples & documentation (Anaël, Florence, Yann, Guillaume)
Roadmap
:warning: This is an alpha version and thus should be used with caution. While we have done our best to test all the functionalities, there is no guarantee that the pipeline is entirely bug-free. See Roadmap below for functionalities that will be implemented in the futur.
Alpha [Spring 2020]
First public version with a basic demonstration of the pipeline.
Availabel functionalities:
[TABLE]
Beta [Summer 2020]
Updated version with those functionalities:
[TABLE]
Release [Fall/Winter 2020]
Full stable version, including functionalities:
[TABLE]
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.