BrkRaw Tutorial (Jupyter Notebooks)

This repository contains tutorials for the updated BrkRaw API using the example datasets hosted via Git LFS.

Notebooks

• notebooks/00_getting_started.ipynb — install, download example data, and run core BrkRaw workflows (info, metadata, conversion).
• notebooks/01_orientation_unwrap_vs_pose.ipynb — compare unwrap pose vs subject pose, reorient to RAS, and visualize the differences.
• notebooks/02_cli_tutorial.ipynb — run the same workflow from the CLI with bash commands and inspect outputs inline.

Launch on Binder

Open the notebook list:

Open a specific notebook:

• notebooks/00_getting_started.ipynb
• notebooks/01_orientation_unwrap_vs_pose.ipynb
• notebooks/02_cli_tutorial.ipynb

Local setup (recommended for Git LFS)

git lfs install

git clone https://github.com/BrkRaw/brkraw-dataset

# Create the tutorial environment
conda env create -f environment.yml
conda activate brkraw-tutorial

jupyter lab

Notes

• The example datasets are stored in the brkraw-dataset repo using Git LFS. Make sure Git LFS is installed before cloning so you get the actual data.
• The notebooks assume the dataset repo lives at data/brkraw-dataset.