2Installation

The easiest way to install Faery is through the pypi reposity using pip:

pip install faery

Note that we recommend the use of a virtual environment to install Faery.

2.1Using pipx or uv¶

Instead of pip, you can use alternatives like pipx or uv. The installation should be straight-forward:

2.2Installing from source¶

You can install Faery yourself by pulling the git repository and building the code locally.

git clone https://github.com/aestream/faery
cd faery
pip install -e .

More information about development setup is available in the page about developing Faery.

2.3Installing event camera drivers¶

To use Faery with event cameras, you need to install the event-camera-drivers package. This can be done with pip

pip install event-camera-drivers

or uv

uv add event-camera-drivers

More information is available in the event-camera-drivers repository. Please submit a ticket in the event-camera-drivers issue tracker if you encounter any problems related to camera drivers.