Skip to content

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

Requirements

BORIS requires the installation of:

Install requirements

Open a terminal (1) and type:

  1. See Open the Ubuntu terminal or Open the Linux Mint terminal
sudo apt install libmpv2 ffmpeg graphviz libxcb-cursor0 

# your password will be required

BORIS was successfully tested on Ubuntu 20.10+

Open a terminal and type: 

sudo pacman -Syu
sudo pacman -S libmpv ffmpeg graphviz

# your password will be required

Open a terminal and type:

su
# your root password will be required

apt install libmpv2 ffmpeg graphviz libxcb-cursor0 libopenblas-dev

BORIS was successfully tested on Debian 12+

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

  1. See Open PowerShell or 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.

Install Homebrew if not already installed from https://brew.sh

Open a terminal (1) and type:

  1. See Open a terminal on macOS
brew install mpv ffmpeg pkg-config cmake gfortran openblas

Note

Homebrew is "The Missing Package Manager for macOS (or Linux)"

Run BORIS

Install the uv Python package and project manager from Astral

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

Open a terminal (1) and type:

  1. See Open an Ubuntu terminal , Open a Linux Mint terminal or Open a macOS terminal

wget -qO- https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env

or

curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env

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

  1. See Open PowerShell or Open a command prompt
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Launch BORIS

Open a terminal (1) and type:

  1. See Open the Ubuntu terminal or Open the Linux Mint terminal

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

  1. See Open PowerShell or Open a command prompt

Open a terminal (1) and type:

  1. See Open a terminal on macOS
uvx boris-behav-obs@latest

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

Test a pre-release of BORIS

If you'd like to help with BORIS development, you can test a pre-release version and report any bugs you encounter.

Check if pre-releases are available on Python Package Index (PyPI).

Launch the pre-release version:

Open a terminal (1) and type:

  1. See Open the Ubuntu terminal or Open the Linux Mint terminal
uvx --prerelease allow boris-behav-obs@latest

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

  1. See Open PowerShell or Open a command prompt
uvx --prerelease allow boris-behav-obs@latest

Open a terminal (1) and type:

  1. See Open a terminal on macOS
uvx --prerelease allow boris-behav-obs@latest

By default, the latest pre-release is launched. If no pre-releases are available, the current stable version of BORIS is used instead.

To force the use of a specific pre-release, run:

uvx --prerelease allow boris-behav-obs==x.y.z

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.