Install/Update¶
This section covers installing and updating ovi. Currently this must be done manually. As the project evolves, a curl‑to‑bash installer/updater will be added.
Installation¶
-
Clone the git repo for the latest changes, or download the .zip file from the release you want and extract it.
-
Change into the directory containing the source code
-
Run the setup script:
The installation is now complete!
Updating¶
-
If you cloned the git repo during installation, simply run
git pull. If you downloaded a .zip file, download the new release and extract it. -
Change into the directory containing the new source code
-
Run the setup script again:
ovi has now been updated!
Setup script¶
This script supports --verbose for full command output and --force to allow overriding an existing non-ovi ovi command.
This file is located at project_root/setup.sh
Requirements¶
- Should be run as a non-root user with sudo privileges. The script will prompt for sudo authentication.
- Must have sudo and bash installed on the system.
- Must use a glibc-based Linux distribution with one of the following package managers:
apt,dnf,yum,pacman, orzypper.
Limitations¶
- On RHEL enterprise environments(AlmaLinux, Rocky Linux, etc. - Excluding Fedora) the script will not automatically resolve dependencies for OpenVINO GPU acceleration.
- Supports only glibc-based Linux distributions, using one of the following package managers:
apt,dnf,yum,pacman, orzypper.
Testing¶
The installer has been tested on the following distributions:
- Ubuntu 26.04
- Debian 12 Bookworm
- Fedora 40
- Arch Linux
- openSUSE tumbleweed
- AlmaLinux 9
- Rocky Linux 9
- Alpine Linux is not supported, since the OpenVINO GPU stack it relies on requires a glibc-based distro.
What the script does¶
Tip
You may inspect the script yourself before running it
-
Checks that the system is not Alpine Linux.
-
Verifies sudo access and prompts for authentication if needed.
-
Grants executable permissions to the
ovilauncher script. -
Detects the available package manager (
apt,dnf,yum,pacman, orzypper) and installs the OS-level OpenCL/GPU dependencies needed for OpenVINO acceleration. -
Detects and fixes hardware device permissions for
/dev/drirender and video nodes when present, and adds the current user to thevideo/rendergroups when needed. -
Ensures a modern Python version is available (
3.11through3.14), installing it automatically if the system is missing one. On Debian/Ubuntu it installsuvand uses it to provision Python 3.14 when needed. -
Creates a local virtual environment (
ovi-env) and installs the project requirements into it. -
Updates the shebang in
ovito point at the best possible Python interpreter. -
Installs the global
ovicommand into/usr/local/binby creating a symlink. If an existing command namedoviis found and it is not already an ovi installation, the script aborts for safety. To override that protection, rerun the script with the--forceflag.
This script is safe to run multiple times.
If you encounter any bugs/issues, open an issue on GitHub