pupil_recording_interface
=========================

.. TODO document recording/gaze estimation capabilities

This Python package provides a user-friendly way of working with recordings
from the Pupil Core eye tracking system. It includes interfaces for both
reading and recording gaze and video data as well as some additional features
such as optical flow calculation or recording of head tracking data.

The code is hosted on GitHub: https://github.com/vedb/pupil_recording_interface

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   installation

.. toctree::
   :maxdepth: 1
   :caption: User guide

   reading
   streaming
   processing
   analysis
   additional
   custom
   auto_examples/index

.. toctree::
   :maxdepth: 1
   :caption: Help & reference

   api
   whatsnew
   contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`