Python HEDTools

Welcome to the Python HEDTools documentation! This package provides comprehensive tools for working with Hierarchical Event Descriptors (HED) - a standardized framework for annotating events and experimental metadata in neuroscience and beyond.

What is HED?

HED is a standardized vocabulary and annotation framework designed to systematically describe events experimental data, particularly neuroimaging and behavioral data. It’s integrated into major neuroimaging standards:

  • BIDS (Brain Imaging Data Structure)

  • NWB (Neurodata Without Borders)

Key features

  • Validation: Verify HED annotations against official schemas

  • Analysis: Search, filter, and summarize HED-annotated data

  • BIDS integration: Full support for BIDS dataset validation and processing

  • NWB support: Read and write HED annotations in NWB files using ndx-hed

  • Multiple formats: Work with JSON sidecars, TSV files, Excel spreadsheets

Getting started

Programming with HEDTools

API documentation

Indices and tables