Build Instructions

NB: Document last updated for OpenViBE 3.6.0.
Older versions:

1. Getting the sources

From archive

An archive of the sources is available on the downloads page.

Important: When extracting the source archive, the directory path must NOT contain any spaces or special characters such as whitespace, &, |, (, ) etc.

 

  • Good example : C:\work\openvibe\
  • Bad example (blanks) : C:\Program Files\openvibe

On Windows, we recommend to keep the path as short as possible or you may run into compiling problems.

From Gitlab

You can clone OpenViBE repository with the following command:

git clone --recurse-submodules git@gitlab.inria.fr:openvibe/meta.git

2. Setting up environment

Install miniconda

install miniconda: https://docs.conda.io/projects/miniconda/en/latest/ (for Windows, use a powershell for the following steps).

setup virtual environment

From the top level of the source directory, run the following command in order create a virtual environment with all necessary dependencies to build OpenViBE:

conda env update -f conda/env_{linux|osx|windows}.yaml

3. Building OpenViBE

On Windows

The commands detailed below need to be executed in a Powershell command prompt.

The following steps assume that you have installed Visual Studio 2019

Setup Visual studio in prompt

In order to setup Visual Studio compiler in your Powershell prompt, run the following commands:

$vsPath = &"${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe" -version '[16.0,17.0)' -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationpath
Import-Module (Get-ChildItem $vsPath -Recurse -File -Filter Microsoft.VisualStudio.DevShell.dll).FullName
Enter-VsDevShell -VsInstallPath $vsPath -SkipAutomaticLocation -DevCmdArguments '-arch=x64'

Build OpenViBE

From the top level directory of the sources, create a build folder, and build OpenViBE with the following commands:

mkdir build; cd build
cmake .. -G Ninja
ninja -j 4

On Linux and MacOS

From the top level directory of the sources, create a build folder and build OpenViBE with the following commands:

mkdir build; cd build
cmake ..
make -j 4

4. Running OpenViBE

The built applications are located in the build, under the bin/ folder. You can therefore launch the designer with the following:

./bin/openvibe-designer

Running tests (Optional)

The SDK tests can be run with the following:

  • Unit Tests
cd sdk/unit-test ; cTest -T Test --output-on-failure ; cd ../..
  • Validation Tests
cd sdk/validation-test ; cTest -T Test --output-on-failure ; cd ../..

The Extras tests can be run with the following command:

cd extras; cTest -T Test --output-on-failure ; cd ..

This entry was posted in Uncategorized. Bookmark the permalink.