brainheart

A pipeline for Brain-Heart Analysis, wrapping Neurokit2 functions and handling Annotations for Brain-Heart Analysis

Installation

Prerequisites

• Python 3.8 or higher
• pip (Python package installer)

Installing from Source

1. Clone or download this repository:

   git clone https://github.com/m2b3/azhao2025Project.git
   cd brainheart

2. Install the package:

   pip install .

Installing in Development Mode

If you're actively developing the package and want changes to be immediately reflected:

pip install -e .

Fresh Computer Setup

If you're starting from a completely fresh computer:

1. Install Python:

   • Download and install Python from python.org
   • Make sure to check "Add Python to PATH" during installation

2. Verify installation:

   python --version
   pip --version

3. Follow the installation steps above

Virtual Environment (Recommended)

It's recommended to install the package in a virtual environment:

# Create a virtual environment
python -m venv venv

# Activate it
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install the package
pip install .

Usage

This package provides an example script, found in test_ecg_widget.py. The reference data comes from (1), with subject "sub-4r3o". To run the file, please download the subject's folder from https://dabi.loni.usc.edu/dsi/W4SNQ7HR49RL, and add the destination of its parent directory in config.py.

Afterwards, you can run the script as follows:

python -i .\brainheart\demo.py

Dependencies

The package automatically installs the following dependencies:

• numpy
• pandas
• mne
• mne_bids
• neurokit2

Bibliography

1. Paulk, A. C. et al. Local and distant cortical responses to single pulse intracranial stimulation in the human brain are differentially modulated by specific stimulation parameters. Brain Stimulat. 15, 491–508 (2022).