Skip to content

README.md

Latest commit

 

History

History
108 lines (71 loc) · 2.65 KB

README.md

File metadata and controls

108 lines (71 loc) · 2.65 KB

HyPyP Cookbook

A community-driven onboarding kit for HyPyP — the Hyperscanning Python Pipeline.

This repository contains tutorials, documentation, and examples to help you go from "I installed HyPyP" to "I can run a complete synchrony workflow and understand what I'm doing."

Quick Start

1. Install HyPyP

# Using pip
pip install hypyp

# Or using poetry (recommended for development)
git clone https://github.com/ppsp-team/HyPyP.git
cd HyPyP
poetry install

2. Clone this Cookbook

git clone https://github.com/ppsp-team/HyPyPCookbook.git
cd HyPyPCookbook
pip install -r requirements.txt

3. Run your first notebook

jupyter notebook notebooks/hello_synchrony.ipynb

Brainhack Montreal 2026

This Cookbook was initiated during Brainhack Montreal 2026.

Project Goals

  1. Day 1 — Onboarding Kit Baseline

    • Refreshed Quickstart
    • Cookbook skeleton
    • 5+ "good first issues"
    • Friction log (newcomer pain points)

  2. Day 2 — Tutorials End-to-End

    • 2-3 runnable notebooks with saved outputs
    • Common pitfalls documentation
    • Unit tests for pipelines

  3. Day 3 — Demo-Ready Output

    • Complete demo notebook (<10 min)
    • "How to contribute" guide
    • Summary report

Pick an Issue

We have issues for all skill levels:

Level Issues
Beginner (no coding) Documentation, glossary, friction testing
Intermediate (Python) Notebooks, CI setup, pitfalls page
Advanced (engineering) Stats rework, performance optimization, API fixes

View all issues

Contributing

We welcome contributions of all kinds! See CONTRIBUTING.md for:

  • How to set up your environment
  • How to submit a pull request
  • Code style guidelines
  • How contributions are credited

First time contributing to open source? Look for issues labeled good first issue.

Contributors

Thanks to everyone who has contributed to this Cookbook!

Name Contributions

Related Resources

License

This project is licensed under the BSD 3-Clause License — see the LICENSE file for details.