Setup - jackspaceBerkeley/pupil GitHub Wiki

A quick note on operating systems -- If you have a choice we recommend the OS's in this order: Linux, Mac (10.8 and above), Windows. Pupil is equally well supported on Mac and Linux. Getting Pupil running on Linux is the most convenient. Bundles are not supported on MacOS 10.7 - please upgrade to 10.8 or above.

Minimum Hardware Specs

We are able to make recordings with Pupil Capture on a 2010 11inch Macbook Air. The CPU of our test machine is a Intel Core2Duo SU9400 - this means that Pupil should run on any "i" type intel processor now.

This test was done using Linux, we know that some internals on MacOS are slightly less efficient so you may need a little bit more steam if you run MacOS (any recent Mac will do fine though.)

We are always working on new features, fixing bugs, and making improvements so make sure to visit the release page frequently to get the latest!

Installing Dependencies

  • Linux step-by-step instructions for recent Ubuntu distros
  • MacOS step-by-step instructions for MacOS 10.8+
  • Windows step-by-step instructions for Windows

Download and Run Pupil Source Code

Once you have all dependencies installed, you're 99% done. Now, all you have to do fork the github repository. Or, using the terminal you can clone the Pupil repository using git:

cd /the_folder_where_Pupil_will_live/
git clone https://github.com/pupil-labs/pupil.git

Run Pupil Capture from Source

You're in development land now. If you're running from the source, there will be no icon to click. So fire up the terminal, navigate to the cloned Pupil repository, and start Pupil using Python.

cd /the_folder_where_Pupil_lives/pupil_src/capture
python main.py

Update Pupil Software

If you've got the Pupil app bundle, you can just go the the release page and download the most recent release. No harm in having more than one release on your machine!

If you're running from the source, fire up your terminal and use git to update to the latest version with these commands.

cd your_pupil_folder
git stash (This command will delete changes you may have made to the code. Don't worry, your data folders will be safe!)
git clean -f -d 
git pull