ARM Installation¶
CVEDIA-RT can run on any ARMv8.0 and newer, ARMv7l is also supported, although some restrictions may apply.
To get the best performance make sure your CPU has asimd
and / or neon
instruction sets available / enabled.
Checking for neon support
You can run cat /proc/cpuinfo | grep -i feat
to see what features are enabled. You should see asimd
or neon
in that list.
This document covers the install in a generic arm device, we also support other arm based devices, such as Ambarella and NVIDIA Jetson.
Requirements¶
CVEDIA-RT will work with any Linux distro that can run dockers or with minimum glibc 2.27 (2.31 recommended) natively with deb
packages.
CVEDIA-RT works on x86_64
, aarch64
, armv7a
and armhf
ISAs.
CVEDIA-RT been tested on Ubuntu 18 and 20, other platforms and systems are not supported / tested.
Docker install¶
- 16G disk space
- Docker 20.04 or newer
To run on GPU using NVIDIA, you will also need:
- CUDA 10.2+
- NVIDIA GPU with Compute Capability greater or equal to 5.2
Check Compute Capability to make sure your gpu is compatible.
If you don't have docker installed
Check install docker guide.
If you don't have NVIDIA Docker installed
Check the official install guide from NVIDIA.
Native install¶
- Debian-like distro with glibc >= 2.27 (run
ldd --version
to check) - ~8G disk space
- dpkg or similar package manager
To run on GPU using NVIDIA, you will also need:
- CUDA toolkit
Check Compute Capability to make sure your gpu is compatible.
Installation¶
Docker¶
By default CVEDIA-RT will run a GUI, that may require some X11 changes, the install.sh
script will check if your current settings are compatible and perform changes as needed.
You may need to restart your X11 session after changes are performed.
- Extract the
.tar.gz
file you downloaded:tar -xzvf <filename.tar.gz>
- Run install script:
sudo ./install.sh
Running with GUI¶
Run ./run.sh
to start.
Depending on the devices and platform you're running you may be required to run as sudo
or start the docker with privileged
mode, this is automatically decided by the startup script.
Running Headless / REST¶
Run ./run.sh --remote
to start.
CVEDIA-RT will be accessible via REST API on port 8080
Remote UI¶
As of 2022.11.0
release you can run CVEDIA-RT in remote GUI mode. To run in this mode you don't need to install a window manager nor x11.
Please check Remote UI for more info.
Running options
There's several ways to run CVEDIA-RT, please refeer to Running Options for all available options.
Solutions and persistence¶
When running CVEDIA-RT within docker, changes on solutions are ephemeral, if you want to make your solution changes persist, please check solution persistence.
Native¶
As of 2024.1.0
releases CVEDIA-RT is now shipped thru our own apt repository.
This allows you to update automatically or pin a specific version of RT. This works on all systems we support, including jetson and aarch64 distros.
Hard paths
The native install will be placed at a fixed path: /opt/cvedia-rt which will potentially overwrite any files you may have there.
Installing using convenience script¶
curl -sqko - http://get.cvedia.com | sudo bash
apt install cvedia-rt -y
Installing by manually adding the apt repository¶
curl -sqko - http://apt.cvedia.com/key.gpg | sudo gpg --dearmour -o /etc/apt/trusted.gpg.d/cvedia.gpg
sudo echo "deb http://apt.cvedia.com cvedia main" > /etc/apt/sources.list.d/cvedia.list
sudo apt update
sudo apt install cvedia-rt -y
CVEDIA-RT binaries¶
CVEDIA-RT deb package will add a few binaries to your path (/usr/bin
):
rtcmd
rtstudio
rtservice
Uninstalling
You can uninstall using the package manager apt remove cvedia-rt
Running with GUI¶
Just call cvediart
, a window will show up.
Running Headless / REST¶
Run cvediart --remote
to start.
CVEDIA-RT will be accessible via REST API on port 8080
Remote UI¶
As of 2022.11.0
release you can run CVEDIA-RT in remote GUI mode. To run in this mode you don't need to install a window manager nor x11.
Please check Remote UI for more info.
Running options
There's several ways to run CVEDIA-RT, please refeer to Running Options for all available options.
Troubleshooting¶
If you're running in GUI mode and CVEDIA-RT crashes with FATAL [..] [glfwui.cpp:68] glfwCreateWindow ..
, you can try:
- On windows:
CVEDIA-RT.bat --dx11
- On windows:
CVEDIA-RT.bat --glfw
- On windows:
CVEDIA-RT.bat --sdl
- On linux with docker:
./run.sh --gl 0
- On linux native:
cvediart --sdl
- On linux native:
cvediart --glfw
If none of this options work, you can still run without UI then connect from a different machine using Remote UI:
- On windows:
CVEDIA-RT.bat --remote
- On linux with docker:
./run.sh --remote
- On linux native:
cvediart --remote
On linux CVEDIA-RT might fail to start if your desktop resolution is smaller than 1280x720
.
If you don't have a graphical interface or cannot run in this resolution, you can run headless with Remote UI (./run.sh --remote
on docker, or cvediart --remote
natively)
If you're having issues after the application has started, logs are automatically saved under the log
folder. Each session of CVEDIA-RT will create a new log entry in that folder, to submit support requests get the most recent log from that folder.
On linux for startup errors within docker, we recommend running test.sh
, this will create a detailed log of system capabilities which can then be used to submit support requests to our team.
For any other questions and inquiries, check the support page.
How to run your first project : Quick Start