Quickstart Guide

Welcome to the Ouster SDK documentation!

This quickstart guide is designed to get you up and running with the Ouster SDK as quickly as possible. We’ll walk through everything starting from installation to your first visualization.

Supported Platforms

The Ouster SDK is distributed as pre-built binaries and can be easily installed using pip, the Python package installer. The SDK is available on the Python Package Index (PyPI ) for the following platforms:

  • Most glibc-based Linux distributions on x86_64 and ARM64 platforms (manylinux_2_28_x86_64, manylinux_2_28_aarch64)

  • macOS >= 14 on x86_64 platforms (macosx_14_0_x86_64)

  • macOS >= 14 on Apple Silicon for Python >= 3.8 (macosx_14_0_arm64)

  • Windows 10/11 on x86_64 platforms (win_amd64)

All of our code hosted on GitHub is open source. You can find the Ouster SDK repository here: https://github.com/ouster-lidar/ouster-sdk .

Building from source is supported on:

  • Ubuntu 20.04, 22.04, and Debian 11 (x86-64, aarch64)

  • macOS >= 14 (arm64, x86-64)

  • Windows 10/11 (x86-64)

The Ouster SDK drops languages and platforms as they exit their standard support cycle. Please follow our Lifecycle Policy page to understand when support for a Python version, C++ compiler, Operating System, or Sensor FW may dropped from support.