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. HED is integrated into major neuroimaging standards:

• BIDS (Brain Imaging Data Structure)

• NWB (Neurodata Without Borders)

This package enables you to validate, analyze, and manipulate HED annotations in various formats:

• 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

• User guide
  • Table of contents
  • Getting started
  • Working with HED schemas
  • Validating HED strings
  • Working with BIDS datasets
  • Working with sidecars
  • Jupyter notebooks
  • Command-line tools
  • Best practices
  • Troubleshooting
• API
  • Models
  • Schema
  • Validator
  • Tools
  • Error handling

• Index