Welcome to PyNeon documentation

PyNeon is a light-weight library to work with Neon (Pupil Labs) multi-modal eye-tracking data. It is a community-driven effort to provide a versatile set of tools to work with the rich data (gaze, eye states, IMU, events, etc.) provided by Neon.

PyNeon works with the cloud-processed data from Pupil Cloud instead of “native” data from the Companion app. To read data in the “native” format, please see pl-neon-recording pupil-labs/pl-neon-recording (which also inspired PyNeon).

Here we provide tutorials and API reference to help you get started with PyNeon.

Installation

To install PyNeon, clone the PyNeon repository from ncc-brain/PyNeon and run:

pip install .

PyPI and conda releases are planned for the future.

Data format

PyNeon works with the “Timeseries Data” or “Timeseries Data + Scene Video” formats as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings.

License

MIT License

Copyright (c) 2024 PyNeon developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.