Ouster SDK Installation¶

This section contains the installation instructions for the Ouster SDK on suported platforms in previous page.

The Ouster Python SDK is provided as pre-built binaries on PyPI. It’s recommended to install it in a virtual environment The binary packages require Python >= 3.8; <= 3.13 and pip >= 19.0 on most platforms.

To install, first ensure pip is up to date, then install the ouster-sdk package using the command below:

Note

Using a virtual environment with the Ouster Python SDK is recommended. Users newer to Python should read the official venv instructions and ensure that they upgrade pip after activating their venv. If you’re using venv on Windows, you’ll want to use python3 and pip3 instead of py -3 and py -3 -m pip in the following Powershell snippets.

Note

Python 3 when installed with macOS Developer Tools uses LibreSSL 2.8.3 (or an older version.) OusterSDK, like many Python 3-compatible packages, requires urllib3 which is not compatible with LibreSSL and requires OpenSSL 1.1.1 or newer. To account for this, macOS users should install an official distribution of Python 3 or one provided by Homebrew, as these use OpenSSL 1.1.1 or newer. In either case, installing OusterSDK into a Python 3 virtual enviroment is still recommended.

If you’re using an unsupported platform like a non-glibc-based Linux distribution, or wish to modify the Ouster Python SDK, you will need to build from source.

See the development instructions for building the Python code or C++ code from source using the links.

To install on supported platforms, first make sure you have the latest version of pip and setuptools:

Linux/macOS

$ python3 -m pip install --upgrade pip setuptools

Windows x64

PS >  py -3 -m pip install --upgrade pip setuptools

Now that your Python environment has an up-to-date pip, you can install latest ouster-sdk using the command below:

Linux/macOS

To upgrade:

$ python3 -m pip install --upgrade ouster-sdk

For a fresh install:

$ python3 -m pip install ouster-sdk

Windows x64

To upgrade:

PS > py -3 -m pip install --upgrade ouster-sdk

For a fresh install:

PS > py -3 -m pip install ouster-sdk

To check that you’ve successfully installed the latest version of the Ouster Python SDK, run the following command and make sure that the ouster-sdk package is included in the output:

Linux/macOS

$ python3 -m pip list

Windows x64

PS > py -3 -m pip list

You should see something like:

ouster-sdk                    1.0.0

Proceed to the next section to visually confirm your installation.