Welcome to Hypline¶
Hypline is a Python package that provides a CLI tool for cleaning and analyzing data from hyperscanning studies involving dyadic conversations.
Installation¶
Hypline can be installed using pip or other package managers such as uv and poetry.
pip install hypline
uv add hypline
poetry add hypline
Quick Start¶
Once the package is installed, hypline command will be available, like so:
hypline --help
Running the above will display an overview of the tool, including supported subcommands.
For instance, clean is a subcommand for performing confound regression to clean BOLD outputs from fMRIPrep, and its details can be viewed by running:
hypline clean --help
What Next¶
Please check out user guides for more detailed instructions and examples.