HED Python Tools

Welcome to the Hierarchical Event Descriptor (HED) Python Tools documentation. This library provides comprehensive tools for working with HED schemas and annotations.

What is HED?

HED (Hierarchical Event Descriptor) is a system for describing events in machine-actionable form. HED tags are comma-separated path strings that describe what happened, when it happened, and other relevant properties.

Quick Start

Install HED Python tools:

pip install hedtools

Basic usage:

from hed import HedString, load_schema

# Load a HED schema
schema = load_schema()

# Create and validate a HED string
hed_string = HedString("Sensory-event, Visual-presentation")
issues = hed_string.validate(schema)

Features

• Schema Management: Load, validate, and work with HED schemas
• String Validation: Validate HED annotation strings
• BIDS Integration: Tools for working with BIDS datasets
• Spreadsheet Support: Import/export HED annotations from spreadsheets
• Sidecar Processing: Handle BIDS sidecar files

Navigation

• Introduction: Learn about HED concepts and terminology
• User Guide: Step-by-step tutorials and examples
• API Reference: Complete API documentation

Links

• Source Code
• HED Standard
• BIDS

Support

For questions and support, please visit our GitHub repository.