2.2. Linux

2.2.1. Installation

2.2.1.1. Online installation

We provide online installation packages for Python versions 3.9 to 3.13.

pip3 install pyorbbecsdk2

2.2.1.2. Offline installation

We provide offline installation packages for Python versions 3.8 to 3.13.

2.2.1.2.1. Prerequisites

Make sure Python is installed on your local system, and that your Python version is 3.8 or higher.

check your Python version:

python3 --version

2.2.1.2.2. Download the Appropriate .whl Package

Download the .whl installation package that matches your local Python version from the Python Wrapper Release

For example, if your Python version is 3.11.9, look for a .whl file that matches cp311 and your platform (e.g., Linux x86_64). A typical file name will look like:

pyorbbecsdk-2.0.13-cp311-cp311-linux_x86_64.whl

2.2.1.2.3. Install the Package

Navigate to the directory where you downloaded the .whl file and run:

python3 -m pip install pyorbbecsdk-2.0.13-cp311-cp311-linux_x86_64.whl

2.2.2. Verify the Installation

Check whether the package was installed successfully:

For online installation, use pyorbbecsdk2.
For offline installation, use pyorbbecsdk.

python3 -m pip show pyorbbecsdk     #or pyorbbecsdk2

If the output shows a Location: field, the package was installed successfully at that path. For example:

lijie@lijie-orbbec:~$ python3 -m pip show pyorbbecsdk 

Name: pyorbbecsdk
Version: 2.0.13
Summary: pyorbbecsdk is a python wrapper for the OrbbecSDK
Location: /home/lijie/.local/lib/python3.11/site-packages

In this example, your site-packages path is:

/home/lijie/.local/lib/python3.11/site-packages

Inside this directory, you will find the package folder:

/home/lijie/.local/lib/python3.11/site-packages/pyorbbecsdk

Notes: Regardless of whether you installed online installation packages (pyorbbecsdk2) or offline installation packages (pyorbbecsdk),the final installed package folder is always named pyorbbecsdk.

2.2.3. Run the Example

Locate the site-packages path Use the output from the previous step to find your_site_packages_path.
If you are running an example for the first time, you may need to install additional dependencies. Install the example dependencies:
```
python3 -m pip install -r <your_site_packages_path>/pyorbbecsdk/examples/requirements.txt
```

Run an example

cd pyorbbecsdk
python3 examples/color.py

2.3. Windows

2.3.1. Installation

2.3.1.1. Online installation

We provide online installation packages for Python versions 3.8 to 3.13. The installation methods are as follows:

pip install pyorbbecsdk2

2.3.1.2. Offline installation

We provide offline installation packages for Python versions 3.8 to 3.13.

2.3.1.2.1. Prerequisites

Make sure Python is installed on your local system, and that your Python version is 3.8 or higher.

check your Python version:

python --version

2.3.1.2.2. Download the Appropriate .whl Package

Download the .whl installation package that matches your local Python version from the Python SDK Wrapper Release

For example, if your Python version is 3.11.9, look for a .whl file that matches cp311 and your platform (e.g., win x64). A typical file name will look like:

pyorbbecsdk-2.0.13-cp311-cp311-win_amd64.whl

2.3.1.2.3. Install the Package