Install OpenCL Drivers on Ubuntu

  1. Open a terminal window by pressing Ctrl + Alt + T keys on the keyboard, and install the OpenCL driver.

    sudo apt update
sudo apt install intel-opencl-icd

    sudo apt update
sudo apt install intel-opencl-icd

    sudo apt update
sudo apt install intel-opencl-icd

    Note

    Support for Ubuntu 18.04 is removed since SDK 2.10. To see Ubuntu 18.04 instructions for an earlier SDK version, change the Knowledge Base version in the top left corner.

  2. Open Zivid Studio and verify that you do not get OpenCL errors.

Note

If you get OpenCL errors, you might have to add your user to group Video.

  1. Add the NVIDIA GPU driver PPA to your system:

    Open a terminal window by pressing Ctrl + Alt + T keys on the keyboard.

    Add the graphics-driver PPA:

    sudo add-apt-repository ppa:graphics-drivers/ppa

    This will provide info on the current long-lived branch release: `nvidia-xxx`

    ../../../_images/long-lived-branch-release-nvidia.png

  2. Install the current latest drivers for your system:

    sudo apt update
sudo apt install intel-opencl-icd

    sudo apt update
sudo apt install nvidia-driver-xxx

    sudo apt update
sudo apt install nvidia-driver-xxx

    Note

    Support for Ubuntu 18.04 is removed since SDK 2.10. To see Ubuntu 18.04 instructions for an earlier SDK version, change the Knowledge Base version in the top left corner.

    After installing the driver, restart your system:

    sudo reboot

  3. Open Zivid Studio and verify that you do not get OpenCL errors.

Note

If you get OpenCL errors, you might have to add your user to group Video.

Warning

Support for using AMD compute devices/GPUs is removed due to low usage and OpenCL stability issues in the drivers. It is possible to opt in to run the SDK with an unsupported compute device, by enabling an option in the Config.yml file. However, such a setup may give unexpected results and errors, and is not tested by Zivid.

Warning

Radeon no longer supports SPIR on some GPUs, please verify that your GPU drivers support SPIR to be compatible with Zivid Software.

  1. Download and extract the correct Radeon Software for Linux:

    Open a terminal window by pressing Ctrl + Alt + T keys on the keyboard.

    Create a temporary folder and navigate to it:

    mkdir amd
cd amd

    If you go to https://www.amd.com/en/support/kb/release-notes/rn-amdgpu-unified-linux-22-20 you will find a link to a version AMD GPU driver installer which is broken. In the following instructions we will use a version that we have tested and that works. At the time of writing this is version 22.20.3. AMD has a /latest path, but this still points to 22.20, which is broken.

    wget --referer http://support.amd.com http://repo.radeon.com/amdgpu-install/22.20.3/ubuntu/jammy/amdgpu-install_22.20.50203-1_all.deb

    Install this package with apt:

    sudo apt install ./amdgpu-install_22.20.50203-1_all.deb
sudo apt update

    Check your Linux Kernel version:

    uname -r

    For Linux Kernel version 5.4 (Ubuntu LTS), download Radeon Software 20.45 for Ubuntu 20.04:

    wget --referer http://support.amd.com https://drivers.amd.com/drivers/linux/amdgpu-pro-20.45-1188099-ubuntu-20.04.tar.xz

    Extract the contents:

    tar -Jxvf amdgpu-pro-20.45-1188099-ubuntu-20.04.tar.xz
cd amdgpu-pro-20.45-1188099-ubuntu-20.04

    For Linux Kernel version 5.8 (Ubuntu LTS HWE stacks), download Radeon Software 20.50 for Linux 20.04:

    wget --referer http://support.amd.com https://drivers.amd.com/drivers/linux/amdgpu-pro-20.50-1234664-ubuntu-20.04.tar.xz

    Extract the contents:

    tar -Jxvf amdgpu-pro-20.50-1234664-ubuntu-20.04.tar.xz
cd amdgpu-pro-20.50-1234664-ubuntu-20.04

    Note

    Support for Ubuntu 18.04 is removed since SDK 2.10. To see Ubuntu 18.04 instructions for an earlier SDK version, change the Knowledge Base version in the top left corner.

  2. Install the graphics stack.

    AMDs own instructions

    amdgpu-install --usecase=graphics,opencl --no-32 --no-dkms

    Note

    If you require Secure Boot you may have to include DKMS (remove --no-dkms in the above command). For more information see secure-boot-support.

    Now add your user as member of both the render group and the video group.

    sudo gpasswd -a $USER render
sudo gpasswd -a $USER video

    You may have to reboot in order for the changes to take effect.

    sudo reboot

    You may now try to open ZividStudio. If it fails then follow the next steps.

    ZividStudio

    AMDs own instructions.

    ./amdgpu-pro-install --opencl=pal

  3. Follow the steps to Configure Secure Boot (if prompted):

    ../../../_images/secure_boot_1.png
    ../../../_images/secure_boot_2.png
    ../../../_images/secure_boot_3.png

    If you are not able to boot, check System Boot Error After AMD OpenCL Drivers Installation.

  4. Open Zivid Studio and verify that you do not get OpenCL errors.

Note

If you get OpenCL errors, you might have to add your user to group Video.