Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.5 KB

README.md

File metadata and controls

20 lines (12 loc) · 1.5 KB

HEDTools - Python

HED (Hierarchical Event Descriptors) is a framework for systematically describing both laboratory and real-world events. HED tags are comma-separated path strings. The goal of HED is to describe precisely the nature of the events of interest occurring in an experiment using a common language. HED, itself, is platform-independent and data-neutral.

Most people will simply annotate their events by creating a spreadsheet that associates HED tags with event codes or the events themselves. If you have such a spreadsheet, you can use the HED Online Validator currently available at https://hedtags.ucsd.edu/hed to validate your spreadsheet without downloading any tools.

Python subprojects

  • hedtools contains all of the validation and translation tools for hed tags and hed schema.
  • hedweb contains the code to deploy the validators and other HED tools as a web application running in a docker module.
  • hedexamples contains examples in MATLAB scripts, Python scripts, and Jupyter notebooks.

The HEDTools require python 3.8 or greater.

Other links of interest

HED specification documentation: https://hed-specification.readthedocs.io/en/latest/

Documentation: https://hed-python.readthedocs.io/en/latest/

Code climate reports: https://codeclimate.com/github/hed-standard/hed-python