Skip to main content

The Hyperscanning Python Pipeline.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypyp-0.2.0a3.tar.gz (42.8 kB view details)

Uploaded Source

Built Distribution

hypyp-0.2.0a3-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file hypyp-0.2.0a3.tar.gz.

File metadata

  • Download URL: hypyp-0.2.0a3.tar.gz
  • Upload date:
  • Size: 42.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for hypyp-0.2.0a3.tar.gz
Algorithm Hash digest
SHA256 138d877935fb70fcfbbb14565a4136c990b0df75e1ab8930c06981d0278d6bce
MD5 4e1685dbc2d60cb9cffe842d971e1a29
BLAKE2b-256 78af9b51d76b8d32471439d9d82abf2cf256220d8b064f36d82e09ade7983dec

See more details on using hashes here.

File details

Details for the file hypyp-0.2.0a3-py3-none-any.whl.

File metadata

  • Download URL: hypyp-0.2.0a3-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for hypyp-0.2.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 1d204ab5fa25711d3eb046f7f4c7ee06ddf1466f8edab1e06348ae0d526f8901
MD5 1e47c930fcb4a23ae482c455eda6cfa0
BLAKE2b-256 b12b1c17f9479d379baf66a120ad94550f6e260dbebd64d5fdc24ba25193ade8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page