Skip to content

Commit

Permalink
Update install instructions for optional dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
phausamann committed Feb 4, 2024
1 parent 347dbd2 commit 11a367f
Showing 1 changed file with 12 additions and 27 deletions.
39 changes: 12 additions & 27 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ pupil detection.
Many of these dependencies are non-trivial to install, especially on Windows.
Therefore, we recommend installing the library in a conda environment since
conda provides a straightforward way of cross-platform distribution for
non-Python dependencies. We are actively working on packaging those
dependencies that aren't already available through conda. At the moment, only
packages for Linux x64 and Python versions 3.6 and 3.7 are available.
non-Python dependencies. We provide some of the dependencies for
Linux x64 and Python versions 3.6 and 3.7 as conda packages via our own ``vedb`` channel.


.. _example_dependencies:
Expand Down Expand Up @@ -66,28 +65,25 @@ Streaming
To stream video from the pupil cameras you need to install the `PyUVC`_
library.

Linux
~~~~~
Install via pip:

.. code-block:: console
$ pip install pupil-labs-uvc
A conda package is available for Linux:

.. code-block:: console
$ conda install -c vedb -c conda-forge pyuvc
Set these udev rules to access the cameras as a normal user:
On Linux, set these udev rules to access the cameras as a normal user:

.. code-block:: console
$ echo 'SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", GROUP="plugdev", MODE="0664"' | sudo tee /etc/udev/rules.d/10-libuvc.rules > /dev/null
$ sudo udevadm trigger
Windows and MacOS
~~~~~~~~~~~~~~~~~

For these operating systems, follow the instructions on the `PyUVC`_ GitHub
page.

.. _PyUVC: https://github.com/pupil-labs/pyuvc


Expand Down Expand Up @@ -131,32 +127,21 @@ Pupil detection
...............

Pupil detection is implemented based on Pupil Labs' `pupil-detectors`_ and `pye3d`_ packages.
package.

.. _pupil-detectors: https://github.com/pupil-labs/pupil-detectors
.. _pye3d: https://github.com/pupil-labs/pye3d-detector

Linux
~~~~~

Conda packages are available for Linux:

.. code-block:: console
$ conda install -c vedb -c conda-forge pupil-detectors pye3d
Windows and MacOS
~~~~~~~~~~~~~~~~~

Install via pip:

.. code-block:: console
$ pip install pupil-detectors pye3d
On MacOS, you will probably need to install some build dependencies. Please
refer to the `pupil-detectors`_ and `pye3d`_ GitHub pages for details.
Also, conda packages are available for Linux:

.. code-block:: console
$ conda install -c vedb -c conda-forge pupil-detectors pye3d
.. _realsense_dependencies:

Expand Down

0 comments on commit 11a367f

Please sign in to comment.