EyeLinkIO

A lightweight library to import SR Research EDF files into Python.

Important

This Software is pre-alpha, meaning it is currently being developed: Changes to the API (function names, etc.) may occur without warning. This library has been tested with MacOS and Linux, but not Windows.

About the EyeLink Data Format

The EyeLink Data Format (EDF; not to be confused with the European Data Format) is used for storing eyetracking data from EyeLink eyetrackers. It was put forward by the company SR Research. SR Research EDF files store data in a binary format, and reading these files currently requires the eyelink-edfapi C library that is included in the Eyelink Software Developers Kit.

Dependencies

Strictly speaking, EyeLinkIO only requires Numpy, and that the user has the EyeLink Software Developers Kit installed on their machine (One must create a login on the forum to access the download). We also provide helper functions for converting data to pandas DataFrames or MNE-Python Raw instances, after reading the data in. These functions require the user to have those respective packages installed.

Example Usage

See the User Guide.

Acknowledgements

This package was originally adapted from the pyeparse package (created by several of the core developers of MNE-Python). It copies much of the EDF (EyeLink Data Format) reading code.