Skip to content

Latest commit

 

History

History
192 lines (143 loc) · 7.89 KB

compile-linux.md

File metadata and controls

192 lines (143 loc) · 7.89 KB

🏠 Home

Compiling on Linux

Compilation and execution were tested on platforms that meet the following requirements:
OS Ubuntu 22.04 or 24.04
64-bit
Architecture amd64 (x64)
Graphics card support of OpenGL 3.0 or higher
CPU support of AVX2

Warning

Compilation on other platforms (alternative Linux distributions, different versions of Ubuntu, ARM processor architecture etc.) was not tested. For those platforms some adjustments to this guide or to the code itself may be required.

Upgrading OpenEB

Read carefully the Release Notes as some changes may impact your usage of our SDK (e.g. API updates) and cameras (e.g. firmware update might be necessary).

Clean your system from previously installed Prophesee software.

If after a previous compilation, you chose to deploy the Metavision files in your system path, then go to the build folder in the source code directory and launch the following command to remove those files:

sudo make uninstall

Make a global check in your system paths (/usr/lib, /usr/local/lib, /usr/include, /usr/local/include) and in your environment variables (PATH, PYTHONPATH and LD_LIBRARY_PATH) to remove occurrences of Prophesee or Metavision files.

Retrieving OpenEB source code

Clone the GitHub repository:

git clone https://github.com/prophesee-ai/openeb.git --branch 5.0.0

In the following sections, absolute path to this directory is called OPENEB_SRC_DIR.

Caution

If you choose to download an archive of OpenEB from GitHub rather than cloning the repository, you need to ensure that you select a Full.Source.Code.* archive instead of using the automatically generated Source.Code.* archives. This is because the latter does not include a necessary submodule.

Prerequisites

Install the following dependencies:

sudo apt update
sudo apt -y install apt-utils build-essential software-properties-common wget unzip curl git cmake
sudo apt -y install libopencv-dev libboost-all-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler
sudo apt -y install libhdf5-dev hdf5-tools libglew-dev libglfw3-dev libcanberra-gtk-module ffmpeg

Note

Optionally, if you want to run the tests, you need to install Google Gtest and Gmock packages. For more details, see Google Test User Guide:

sudo apt -y install libgtest-dev libgmock-dev

Python libraries

For the Python API, you will need Python and some additional libraries. We support Python 3.9 and 3.10 on Ubuntu 22.04 and Python 3.11 and 3.12 on Ubuntu 24.04.

We recommend using Python with virtualenv to avoid conflicts with other installed Python packages. So, first install it along with some Python development tools:

sudo apt -y install python3.x-venv python3.x-dev
# where "x" is 9, 10, 11 or 12 depending on your Python version

Next, create a virtual environment and install the necessary dependencies:

python3 -m venv /tmp/prophesee/py3venv --system-site-packages
/tmp/prophesee/py3venv/bin/python -m pip install pip --upgrade
/tmp/prophesee/py3venv/bin/python -m pip install -r <OPENEB_SRC_DIR>/utils/python/requirements_openeb.txt

Note

Note that when creating the virtual environment, it is necessary to use the --system-site-packages option to ensure that the SDK packages installed in the system directories are accessible. However, this option also makes your local user site-packages (typically found in ~/.local/lib/pythonX.Y/site-packages) visible by default. To prevent this and maintain a cleaner virtual environment, you can set the environment variable PYTHONNOUSERSITE to true.

Optionally, you can run the activate command (source /tmp/prophesee/py3venv/bin/activate) to modify your shell's environment variables, setting the virtual environment's Python interpreter and scripts as the default for your current session. This allows you to use simple commands like python without needing to specify the full path each time.

The Python bindings of the C++ API rely on the pybind11 library, specifically version 2.11.0.

Note

pybind11 is required only if you want to use the Python bindings of the C++ API. You can opt out of creating these bindings by passing the argument -DCOMPILE_PYTHON3_BINDINGS=OFF at step 3 during compilation (see below). In that case, you will not need to install pybind11, but you won't be able to use our Python interface to the C++ API.

Unfortunately, there is no pre-compiled version of pybind11 available, so you need to install it manually:

wget https://github.com/pybind/pybind11/archive/v2.11.0.zip
unzip v2.11.0.zip
cd pybind11-2.11.0/
mkdir build && cd build
cmake .. -DPYBIND11_TEST=OFF
cmake --build .
sudo cmake --build . --target install

CUDA dependencies

To use Machine Learning features, you need to install some additional dependencies.

First, if you have some NVIDIA hardware with GPUs, you can optionally install CUDA (11.6 or 11.7) and cuDNN to leverage them with pytorch and libtorch.

Make sure that you install a version of CUDA that is compatible with your GPUs by checking NVIDIA compatibility page.

Note

At the moment, we don't support OpenCL and AMD GPUs.

Compilation

  1. Create and open the build directory in OPENEB_SRC_DIR

    mkdir build && cd build

  2. Generate the makefiles using CMake

    cmake .. -DBUILD_TESTING=OFF

    [!NOTE]

    If you want to specify to cmake which version of Python to consider, you should use the option

    -DPython3_EXECUTABLE=<path_to_python_to_use>

    This is useful, for example, when you have a more recent version of Python than the ones we support installed on your system. In that case, cmake would select it and compilation might fail.

  3. Compile

    cmake --build . --config Release -- -j 4

To use OpenEB directly from the build folder, you need to update some environment variables using this script:

source utils/scripts/setup_env.sh

Note

You may add this to your ~/.bashrc to make it permanent:

nano ~/.bashrc
# Add this line to the very end:
source <OPENEB_SRC_DIR>/build/utils/scripts/setup_env.sh

Camera plugins

Prophesee camera plugins are included in OpenEB, but you still need to copy the udev rules files in the system path and reload them so that your camera is detected:

sudo cp <OPENEB_SRC_DIR>/hal_psee_plugins/resources/rules/*.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
sudo udevadm trigger

Final thoughts

Note

If you are using a third-party camera, you need to install the plugin provided by the camera vendor and specify the location of the plugin using the MV_HAL_PLUGIN_PATH environment variable.

To get started with OpenEB, you can download some sample recordings and visualize them with metavision_viewer or you can stream data from your Prophesee-compatible event-based camera.