Tutorials

Learn TimeToAlign! step by step

These tutorials take you from zero to a working multimodal alignment, introducing one concept at a time. Each notebook uses real-world data from the project’s specimen collection and can be run locally after installing the library with pip install -e ".[tutorial]" from the repository root.

Prerequisites: Python 3.12+, basic familiarity with Jupyter notebooks.

Tutorial Notebooks

Title Description
Quickstart A five-minute tour of Timelines
Timelines, Events, and Maps Loading, EventStore, Coordinate, ConversionMap
Children, Regions, and Timestamps Hierarchy, cross-section queries
Timeline Groups and Commensurability TimelineGroup, coordinate transfer, partial alignment
Alignment Bundles MatchfileLoader, AlignmentBundle, cross-group transfer
Flow Control and Grids BeatGrid, repeats, metrical structure
No matching items

Topics at a Glance

The tutorials are designed to be followed in order, grouped into the same four topics used throughout the documentation:

Timelines, Events & Maps

TimelineGroups

AlignmentBundles

In-depth Topics