Skip to content

BORIS is available on the official Python Package Index: BORIS PyPI package

Requirements

BORIS requires the installation of:

Install requirements

Example for Debian based distributions like Ubuntu, Kubuntu, Xubuntu, Linux Mint ...

Open a terminal and type: (1)

  1. If you do not know how to open a terminal, see Ubuntu terminal or Linux Mint terminal
sudo apt install libmpv2 ffmpeg graphviz libxcb-cursor0

# your password will be required

Open a terminal and type:

su
# your root password will be required

apt install libmpv2 ffmpeg graphviz libxcb-cursor0

Open a command prompt or a PowerShell and type: (1)

  1. If you do not know how to open a command prompt, see Open a command prompt
winget install ffmpeg
winget install Graphviz.Graphviz

Note

winget (Windows Package Manager) is a command-line tool for installing, updating, configuring, and managing software on Windows.

Run BORIS

Install the uv Python package and project manager from Astral

uv is an "An extremely fast Python package and project manager, written in Rust" and has more than 70K starts on GitHub

Launch BORIS

Open a terminal and type: (1)

  1. If you do not know how to open a terminal, see Ubuntu terminal or Linux Mint terminal
uvx boris-behav-obs

Open a command prompt or a PowerShell and type: (1)

  1. If you do not know how to open a command prompt, see Open a command prompt
uvx boris-behav-obs

BORIS will launch, do not close the terminal while BORIS is running.

Additional libraries

On Ubuntu 20.04 it can be necessary to install the following libraries:

sudo apt install libxcb-xinerama0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 libxcb-xkb1 libxkbcommon-x11-0
(your password will be required)

and create a symbolic link to the libffi.so.7 library. Open a terminal and type:

sudo ln -s /usr/lib/x86_64-linux-gnu/libffi.so.7 /usr/lib/x86_64-linux-gnu/libffi.so.6
(your root password will be required)

Refer to the change log for a detailed summary of version updates.

If you want to report a bug, see the how to report a bug page.