The Rerun Python SDK
Use the Rerun SDK to record data like images, tensors, point clouds, and text. Data is streamed to the Rerun Viewer for live visualization or to file for later use.
Install
pip3 install rerun-sdk
ℹ️ Note:
The Python module is called rerun, while the package published on PyPI is rerun-sdk.
For other SDK languages see Installing Rerun.
We also provide a Jupyter widget for interactive data visualization in Jupyter notebooks:
pip3 install rerun-sdk[notebook]
Example
import rerun as rr
import numpy as np
rr.init("rerun_example_app", spawn=True)
positions = np.vstack([xyz.ravel() for xyz in np.mgrid[3 * [slice(-5, 5, 10j)]]]).T
colors = np.vstack([rgb.ravel() for rgb in np.mgrid[3 * [slice(0, 255, 10j)]]]).astype(np.uint8).T
rr.log("points3d", rr.Points3D(positions, colors=colors))
Resources
Logging and viewing in different processes
You can run the Viewer and logger in different processes.
In one terminal, start up a Viewer with a server that the SDK can connect to:
python3 -m rerun
In a second terminal, run the example with the --connect option:
python3 examples/python/plots/plots.py --connect
Note that SDK and Viewer can run on different machines!
Building Rerun from source
We use pixi for managing dev-tool versioning, download and task running. See here for installation instructions.
pixi run py-build
This builds the SDK for Python (use pixi run py-build --release for a release build).
You can then run examples via uv:
pixi run uv run examples/python/minimal/minimal.py
To build a wheel instead for manual install use:
pixi run py-build-wheel
Refer to BUILD.md for details on the various different build options of the Rerun Viewer and SDKs for all target languages.
Installing a pre-release
Prebuilt dev wheels from head of main are available at https://github.com/rerun-io/rerun/releases/tag/prerelease.
While we try to keep the main branch usable at all times, it may be unstable occasionally. Use at your own risk.
Running Python unit tests
pixi run py-test
If you run into a problem, run rm -rf .pixi .venv and try again.
Running specific Python unit tests
pixi run py-build && pixi run uvpy -m pytest rerun_py/tests/unit/test_tensor.py
Profiling the Python SDK
Set RERUN_PUFFIN=1 to spawn a puffin_viewer attached to the SDK on startup. The Rust side of the SDK then streams scopes (anything wrapped in re_tracing::profile_function! / profile_scope!) to the viewer for the lifetime of the process.
RERUN_PUFFIN=1 pixi run uvpy your_script.py
Save a recording from the viewer for offline analysis (use the investigate-puffin skill in .claude/skills/).
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rerun_sdk-0.36.0-cp310-abi3-win_amd64.whl.
File metadata
- Download URL: rerun_sdk-0.36.0-cp310-abi3-win_amd64.whl
- Upload date:
- Size: 140.6 MB
- Tags: CPython 3.10+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.14.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
08b3f2bfc5470a7f8feda1b92b2bcff2ec4c51bdf33b8d931c4632b727ff8f7a
|
|
| MD5 |
f9257ee6c33e1aa1c6be17c06c49ad2c
|
|
| BLAKE2b-256 |
f44349a3e7b2a5797c19f5a669fa8782c52f203318f9a9c4aa4d673fd1eedd7e
|
File details
Details for the file rerun_sdk-0.36.0-cp310-abi3-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: rerun_sdk-0.36.0-cp310-abi3-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 163.0 MB
- Tags: CPython 3.10+, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.14.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7a12a9548c5e437f53d4769b4426945b13923d71966945d4fc473ad19829b99
|
|
| MD5 |
32b80f576dbe254e7a27832c8ec702c0
|
|
| BLAKE2b-256 |
eba4c913f4d9b1e3e6fdafa565d1a6dd8faf92610057bbcdcae250bc25268df9
|
File details
Details for the file rerun_sdk-0.36.0-cp310-abi3-manylinux_2_28_aarch64.whl.
File metadata
- Download URL: rerun_sdk-0.36.0-cp310-abi3-manylinux_2_28_aarch64.whl
- Upload date:
- Size: 157.7 MB
- Tags: CPython 3.10+, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.14.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c176c96d64eade6f259d8a36569a0f2d8e9d849f7cb0c48c1ad58cd91d7dce0
|
|
| MD5 |
3c1ed6d46ff7e2a2e71b2c44b08cab8d
|
|
| BLAKE2b-256 |
a0cdc27de1306249d6247bff869f3601b4c317383fd92944d3daef5265c9ba91
|
File details
Details for the file rerun_sdk-0.36.0-cp310-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: rerun_sdk-0.36.0-cp310-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 147.5 MB
- Tags: CPython 3.10+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.14.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7de4cb9f99906b05a38de61ce69883254c845bea401cbe1673bdb32862c5dc60
|
|
| MD5 |
cc00149aa8a9c27102ad3e0451fab5e8
|
|
| BLAKE2b-256 |
90e23ce4fc7fd6f93f1443e1bee3c92b79c99f6de9e23694042a037014d04f08
|
