Python Installation

This guide provides detailed instructions for installing the Voyant API and development packages with Python.

Note: The Python bindings do not replace the need for the compiled tools (like voyant_visualizer).

They should be installed alongside these tools for your development!

The Voyant API Python bindings are available on PyPI starting with v0.4.4:

python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install voyant-api

Requirements:

• Python 3.9 or later (ARM64/aarch64 Linux wheels currently cover 3.9–3.12)
• NumPy 2.0+, Pandas 2.0+
• Linux — x86-64 (Ubuntu 22.04+, Debian 12+, or equivalent) or ARM64/aarch64 (Raspberry Pi OS Bullseye+, Jetson JetPack 5+); Windows (x86-64); or macOS (Apple Silicon)

See the Python and C++ examples in voyant-sdk to get started.

---

Verifying Installation (Optional)

import voyant_api
print(voyant_api.__version__)

Test Installation

1. Clone the Voyant SDK repository

git clone https://github.com/Voyant-Photonics/voyant-sdk.git

2. Run the Live Client Example

The provided example demonstrates how to establish a connection with your Carbon 30 LiDAR sensor and capture incoming frame data.

Follow the linked example and ensure that you observe an output similar to the provided expected output reference.

Uninstalling

Python:

pip uninstall voyant-api

---

You should now be able to interact with the Carbon 30 LiDAR sensor and the Voyant API in the Python language! Please explore the other provided example codes to further your understanding of the Voyant API.