Getting Started
There are many different ways of sending data to the Rerun Viewer depending on what you're trying
to achieve and whether the viewer is running in the same process as your code, in another process,
or even as a separate web application.
Checkout SDK Operating Modes for an
overview of what's possible and how.
APIs
Initialization
Function |
Description |
rerun.init() |
Initialize the Rerun SDK with a user-chosen application id (name). |
rerun.connect() |
Connect to a remote Rerun Viewer on the given ip:port. |
rerun.disconnect() |
Closes all TCP connections, servers, and files. |
rerun.spawn() |
Spawn a Rerun Viewer, listening on the given port. |
rerun.serve() |
Serve log-data over WebSockets and serve a Rerun web viewer over HTTP. |
Viewer Control
Time
Spatial Primitives
Function |
Description |
rerun.log_point() |
Log a 2D or 3D point, with a positions and optional colors, radii, label, etc. |
rerun.log_points() |
Log 2D or 3D points, with positions and optional colors, radii, labels, etc. |
rerun.log_rect() |
Log a 2D rectangle. |
rerun.log_rects() |
Log multiple 2D rectangles. |
rerun.log_obb() |
Log a 3D Oriented Bounding Box, or OBB. |
rerun.log_line_strip() |
Log a line strip through 2D or 3D space. |
rerun.log_line_segments() |
Log many 2D or 3D line segments. |
rerun.log_arrow() |
Log a 3D arrow. |
rerun.log_mesh() |
Log a raw 3D mesh by specifying its vertex positions, and optionally indices, normals and albedo factor. |
rerun.log_meshes() |
Log multiple raw 3D meshes by specifying their different buffers and albedo factors. |
rerun.log_mesh_file() |
Log the contents of a mesh file (.gltf, .glb, .obj, …). |
Images
Tensors
Annotations
Extension Components
Plotting
Function |
Description |
rerun.log_scalar() |
Log a double-precision scalar that will be visualized as a timeseries plot. |
Text
Helpers
Troubleshooting
You can set RUST_LOG=debug
before running your Python script
and/or rerun
process to get some verbose logging output.
If you run into any issues don't hesitate to open a ticket
or join our Discord.