Installation

Follow comprehensive installation guides for PySDK, covering virtual environments, Docker images, and verification.

Supported Environments

PySDK currently supports these operating systems, CPU architectures, and Python versions.

Operating System	Supported CPU Architectures	Supported Python Versions
Ubuntu Linux 20.04, 22.04, 24.04	x86-64	3.9 ... 3.12
Ubuntu Linux 20.04, 22.04, 24.04	ARM AArch64	3.9 ... 3.12
Raspberry Pi OS (64 bit)	ARM AArch64	3.9
Windows 10/11	x86-64	3.9 ... 3.12
macOS 12	ARM AArch64	3.9

Supported Hardware

Below is a summary of what hardware we support, including the runtime, devices, and model binary formats.

Vendor	Runtime	Devices	Model Binary Format
Hailo	HAILORT	HAILO8, HAILO8L	.hef
Google	TFLITE	EDGETPU	.tflite
Intel	OPENVINO	CPU, GPU, NPU	.onnx, .bin & .xml
BrainChip	AKIDA	NSoC_v2, AKD1500	.bin
DeGirum	N2X	ORCA1	.n2x
Rockchip	RKNN	RK3588, RK3568, RK3566	.rknn
MemryX	MEMRYX	MX3	.dfp
AMD	ONNX	VITIS_NPU	.onnx
NVIDIA	TENSORRT	DLA, GPU	.onnx

Installation Options

Using pip install in a Virtual Environment

We recommend creating a Python virtual environment for PySDK and other DeGirum python packages.

Open a command prompt or terminal, then follow the steps for your system below.

Windows

If you do not already have Python installed, we recommend disabling the Windows Python App Execution Alias before trying to install Python and PySDK. You should also ensure you have Visual C++ Redistributable for Visual Studio 2015 and above installed.

Disabling the Windows Python App Execution Alias and Installing Python on Windows

1. Locate the Alias: By default, Windows will overwrite python with Python from the Microsoft Store when entered in a terminal. Search for App Execution Alias in Windows Settings and disable both python.exe and python3.exe aliases.

Windows Python App Execution Aliases for python.exe and python3.exe .

1. Install a Python version supported by PySDK: After disabling the App Execution Alias, install Python from the official Python website or with winget. If you will install Python with winget, install both Python.Python.<version> and Python.Launcher.

Installing PySDK in a Python Virtual Environment on Windows

To install PySDK, ensure a Python version supported by PySDK is installed, then follow this video or the steps below:

Windows Installation

1

Create a Python Virtual Environment

Create a virtual environment with the command:

python -m venv <virtual-environment-name>

If you have Python Launcher and multiple Python versions installed, use py to create the virtual environment:

# Only if you have multiple Python versions installed
py <your-python-version> -m venv <virtual-environment-name>

2

Activate the Python Virtual Environment

After creating the virtual environment with venv, navigate to the Scripts folder in your virtual environment's folder.

cd <virtual-environment-name>\Scripts

When you cd into this folder, you will need to run activate.

# On cmd.exe:
activate

# On pwsh.exe:
.\Activate.ps1

After activating the virtual environment, you will see the name of your virtual environment prefixed before the terminal prompt.

PowerShell terminal with an active degirum-windows virtual environment

3

Install PySDK with pip install

With your virtual environment activated, use pip to install PySDK and optionally degirum-tools. We call the PySDK package degirum. We provide the degirum-tools package to help you write AI applications with PySDK.

# PySDK only
pip install degirum

# PySDK and degirum-tools
pip install degirum degirum-tools

4

Verify PySDK Installation

In the Python virtual environment, run this command:

degirum sys-info

If you see a list of devices detected by PySDK, then PySDK you have successfully installed onto your system.

Linux

Ensure you have a Python version supported by PySDK installed.

Installing Python on Linux

Depending on your Linux distribution, the command to install Python will be different. Choose the proper commands for your system:

# Ubuntu:
sudo apt-get update
sudo apt-get install python<release-number>
# Example: sudo apt-get install python3.12

# RHEL. If using an old RHEL, use yum instead of dnf:
sudo dnf install python<release-number>
# Example: sudo dnf install python3.12

1

Create a Python Virtual Environment

Create a virtual environment with the command:

# python3 does not necessarily point to a Python version supported by PySDK.
# Run python3 --version to verify Python version.
# If python3 is a version supported by PySDK, then create the Python virtual environment.
python3 -m venv <virtual-environment-name>

If you have multiple Python versions installed, you can specify a Python release version to create the virtual environment:

# Only if you have multiple Python versions installed
python<python-version> -m venv <virtual-environment-name>

Creating a Python virtual environment with a specific Python version

2

Activate the Python Virtual Environment

After creating the virtual environment with venv, navigate to the bin folder in your virtual environment's folder and set activate as source.

source <virtual-environment-folder>/bin/activate

After activating the virtual environment, you will see the name of your virtual environment prefixed before the terminal prompt.

Terminal with an active degirum-wsl virtual environment

3

Install PySDK with pip install

With your virtual environment activated, use pip to install PySDK and optionally degirum-tools. We call the PySDK package degirum. We provide the degirum-tools package to help you write AI applications with PySDK.

# PySDK only
pip install degirum

# PySDK and degirum-tools
pip install degirum degirum-tools

Docker Images

We also provide Docker images for the DeGirum AI server and PySDK AI client installations.

Follow this GitHub link to DeGirum Docker repo for details on how to run these images and for corresponding source Dockerfiles.

Runtimes and Drivers

We support multiple hardware options and runtime environments. PySDK comes with support for N2X and TFLite runtimes. Follow this link for more details.

Verification

After installing required runtimes and any needed device drivers, you can verify PySDK access to the runtimes and the devices by running this command in a terminal:

degirum sys-info

The output should contain all the devices available to PySDK and some information about them.

Devices:
<other device types>
    <runtime>/<device type>:
    - '@Index': 0
      <device dependent information, optional>
    - '@Index': 1
      <device dependent information, optional>
      <other devices>
    <other device types>

Troubleshooting

If you encounter errors such as:

ERROR: Could not find a version that satisfies the requirement degirum
ERROR: No matching distribution found for degirum

Try creating a new virtual environment and reinstalling PySDK.

You can also try upgrading the pip package. In your virtual environment, run the following command:

python3 -m pip install -U pip

Additionally, on Windows, ensure you have installed the Visual C++ Redistributable for Visual Studio 2015 and above.