This repository contains user supporting code and documentation for using the Hierarchical Event Descriptor (HED) system for annotating, summarizing, and analyzing data. The repository is organized into three subdirectories:
The datasets subdirectory contains datasets for testing various aspects of HED. These datasets have stubs for actual imaging data in order to reduce their size. Most of these datasets have complete versions available on openNeuro. See datasets/README.md for details.
The hedcode
subdirectory contains MATLAB scripts, Python Jupyter Notebooks,
and Python scripts with direct calls to HedTools.
The repository also contains example code in python and matlab.
See hedcode/README.md for details.
The Python scripts and notebooks require the installation of
hedtools whose installation
is described below.
The docs subdirectory contains the main documentation for this and other HED resources. The HED GitHub organization repository gathers the HED supporting resources, all of which are open source.
The most of the Python-related resources in this repository
require the installation of the HEDTools Python module, which can be
installed using pip or directly from its GitHub repository as follows:
To use pip to install hedtools from PyPI:
pip install hedtools
To install directly from the GitHub repository:
pip install git+https://github.com/hed-standard/hed-python/@master
HEDTools require python 3.7 or greater.