Pupil

Open source eye tracking platform.

Pupil is a project in active, community driven development. Pupil Core mobile eye tracking hardware is accessible, hackable, and affordable. The software is open source and written in Python and C++ when speed is an issue.

Our vision is to create tools for a diverse group of people interested in learning about eye tracking and conducting their eye tracking projects.

Chat with us on Discord.

Users

You don't need to know how to write code to use Pupil. Download the latest apps!

Read the Pupil Core user guide.

Developers

There are a number of ways you can interact with Pupil Core software as a developer:

Use the API: Use the network based real-time API to communicate with Pupil over the network and integrate with your application.
Develop a Plugin: Plugins are loaded at runtime from the app bundle. Note: if your plugin requires Python libraries that are not included in the application bundle, then you will need to run from source.
Run from Source: Can't do what you need to do with the network based api or plugin? Then get ready to dive into the inner workings of Pupil and run from source!

All setup and dependency installation instructions are contained in this repo. All other developer documentation is here.

Installing Dependencies

Ubuntu 18.04 LTS (recommended Linux distribution)
Ubuntu 17.10 or lower
macOS
Windows 10

Clone the repo

After you have installed all dependencies, clone this repo and start Pupil software.

git clone https://github.com/pupil-labs/pupil.git # or your fork
cd pupil

Note: If you are using Windows, you will have to complete a few more steps after cloning the repo. Please refer to the Windows 10 dependencies setup guide.

Run Pupil

Windows

cd pupil_src
run_capture.bat
# or run_player.bat
# or run_service.bat

macOS/Linux

cd pupil_src
python main.py capture # or player/service

Command Line Arguments

The following arguments are supported:

Flag	Description
`-h, --help`	Show help message and exit.
`--version`	Show version and exit.
`--debug`	Display debug log messages.
`--profile`	Profile the app's CPU time.
`-P PORT, --port PORT`	(Capture/Service) Port for Pupil Remote.
`--hide-ui`	(Capture/Service) Hide UI on startup.
`<recording>`	(Player) Path to recording.

License

All source code written by Pupil Labs is open for use in compliance with the GNU Lesser General Public License (LGPL v3.0). We want you to change and improve the code -- make a fork! Make sure to share your work with the community!

WengJunFeng/pupil