rerun-sdk

library0.36.3pypypi✓ verified 27d ago

The Rerun Python SDK is an open-source library for logging, storing, querying, and visualizing multimodal and multi-rate data. It provides Python APIs to stream data like images, tensors, point clouds, and text to the Rerun Viewer for live visualization or to a file for later use. It is currently in active development, with frequent releases, and is particularly useful in areas like robotics, simulation, and computer vision, aiming to help users understand and improve complex processes involving rich, time-aware multimodal data.

data ai-ml observability

pip install rerun-sdk

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · RERUN-SDK

rerun-sdk

datapythonv0.36.3

Install

13.6s avg

Import

993ms

Disk

814MB

Pass rate

5/ 10

Env Coverage5 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.36.3 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

build_error

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 13.6s · import 0.993s · 857MB

814MB installed

● package 814MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

rerun

✓ import rerun as rr

The PyPI package is `rerun-sdk`, but the Python module to import is `rerun`.

This quickstart logs a grid of colored 3D points to the Rerun Viewer. It initializes the SDK, generates synthetic data using NumPy, and then uses `rr.log` to send the `Points3D` archetype to the viewer. The `spawn=True` argument automatically launches the Rerun Viewer application.

import rerun as rr import numpy as np # Initialize Rerun with an application ID and spawn the viewer. # The 'spawn=True' argument will automatically open the Rerun Viewer application. rr.init("my_first_rerun_app", spawn=True) # Generate some example 3D data (a grid of points with colors). SIZE = 10 pos_grid = np.meshgrid(*[np.linspace(-5, 5, SIZE)] * 3) positions = np.vstack([d.ravel() for d in pos_grid]).T col_grid = np.meshgrid(*[np.linspace(0, 255, SIZE)] * 3) colors = np.vstack([c.ravel() for c in col_grid]).astype(np.uint8).T # Log the 3D points with colors to an entity named 'my_points'. rr.log( "my_points", rr.Points3D(positions, colors=colors, radii=0.5) ) print("Logged 3D points. Check the Rerun Viewer!")

rerun --version

Debug

Known issues

breakingThe Rerun SDK is under active development and the API is still evolving. Expect breaking changes between minor versions, especially prior to a 1.0 release. Recent breaking changes (around 0.30/0.31) included updates to gRPC-based viewer communication, the `.rrd` file format, and connection methods.

fix

Refer to the official migration guides and CHANGELOG for specific version updates and API changes. Regularly update and test your code against new releases.

affects: <=0.31.x (pre-1.0)

gotchaThe PyPI package name is `rerun-sdk`, but the Python module to import is simply `rerun`. Using `import rerun_sdk` will result in an `ImportError`.

fix

Always use `import rerun as rr` (or `import rerun`) in your Python code.

affects: All versions

gotchaThe Rerun Viewer might experience slowdowns when visualizing an excessive number of entities or very large point clouds (multi-million points).

fix

Consider optimizing your logging frequency, downsampling large datasets, or using more efficient archetypes for high-volume data. Monitor viewer performance and adjust data complexity as needed.

affects: All versions

gotchaThe Rerun SDK provides multiple operating modes (`spawn`, `connect_grpc`, `serve_grpc`, `save`, `stdout`). By default, these modes will override each other. If you intend to use multiple data sinks concurrently (e.g., streaming to a viewer and saving to a file simultaneously), you must explicitly configure them using `rr.set_sinks()`.

fix

For concurrent data output, use `rr.set_sinks()` to manage multiple sinks. Avoid calling `rr.spawn()`, `rr.save()`, or `rr.connect_grpc()` individually if multiple outputs are required.

affects: All versions

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'rerun'

The 'rerun-sdk' package is not installed in your Python environment or the environment is not correctly activated.

fix

Install the Rerun SDK using pip: `pip install rerun-sdk`

AttributeError: module 'rerun' has no attribute 'log_points'

The direct `log_` functions (e.g., `log_points`, `log_image`, `log_transform`) were deprecated or removed; logging is now done via `rr.log()` with specific component types.

fix

Use `rr.log("entity_path", component_type(...))`. For example, instead of `rr.log_points("my_points", positions)`, use `rr.log("my_points", rr.Points3D(positions))`.

rerun.rerun_error.RerunException: Rerun SDK is not initialized. Call rr.init() first.

You are attempting to log data or perform other SDK operations using `rr.log()` before initializing the Rerun SDK with `rr.init()`.

fix

Add `rr.init("your_app_name", spawn=True)` at the very beginning of your script, before any `rr.log()` calls.

[WARN] Viewer did not connect to the SDK in 5.0s, giving up.

The Rerun Viewer could not establish a connection with the Rerun SDK, often because the viewer isn't running, couldn't be spawned, or a network/firewall issue is blocking port 9999.

fix

Ensure `rr.init("your_app_name", spawn=True)` is called (to automatically launch a viewer), or if `spawn=False`, manually run the Rerun Viewer in a terminal with the command `rerun` before starting your script. Check firewall settings if necessary.

Upgrade

Version history

0.36.3latest on PyPI · released Aug 24, 2026

Audit

Dependencies

numpyoptionalCommonly used for preparing data (e.g., point clouds, images) before logging with Rerun. Not a direct dependency but almost universally used in examples and real-world applications.

Agent activity

34 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/rerun-io/rerun ↗

packagehttps://pypi.org/project/rerun-sdk/ ↗

homepagehttps://www.rerun.io ↗

docshttps://www.rerun.io/docs ↗