Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

HyPyP 🐍〰️🐍

The Hyperscanning Python Pipeline

PyPI version shields.io license Mattermost

:warning: This alpha version is still far from easy-to-use and should be considered 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 our preprint for more explanation and our plan for upcoming functionalities (aka Roadmap).

🤝 If you want to help you can submit bugs and suggestions of enhancements in our Github Issues section.

🤓 For the motivated contributors, you can even help directly in the developpment of HyPyP. You will need to install Poetry (see section below).

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)

Poetry installation (only for developpers)

Step 1: pip install poetry

Step 2: git clone git@github.com:GHFC/HyPyP.git

Step 3: cd HyPyP

Step 4: poetry install

Step 5: poetry shell

Release files for hypyp 0.2.0a3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hypyp 0.2.0a3
File Size Uploaded
hypyp-0.2.0a3.tar.gz 42.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hypyp 0.2.0a3
File Interpreter ABI Platform
hypyp-0.2.0a3-py3-none-any.whl Python 3 none any Details

Total release size: 87.3 kB

Release files / hypyp-0.2.0a3.tar.gz

Download URL hypyp-0.2.0a3.tar.gz
Size 42.8 kB
Tags Source
SHA-256 checksum
How to use checksums
138d877935fb70fcfbbb14565a4136c990b0df75e1ab8930c06981d0278d6bce
BLAKE2b-256 checksum
How to use checksums
78af9b51d76b8d32471439d9d82abf2cf256220d8b064f36d82e09ade7983dec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

Release files / hypyp-0.2.0a3-py3-none-any.whl

Download URL hypyp-0.2.0a3-py3-none-any.whl
Size 44.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d204ab5fa25711d3eb046f7f4c7ee06ddf1466f8edab1e06348ae0d526f8901
BLAKE2b-256 checksum
How to use checksums
b12b1c17f9479d379baf66a120ad94550f6e260dbebd64d5fdc24ba25193ade8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

Release history Release notifications | RSS feed

0.6.0

2 release files

This release

0.2.0a3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page