Skip to content

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 functions

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.save() Stream all log-data to a file.
rerun.send_blueprint() Create a blueprint from a BlueprintLike and send it to the RecordingStream.
rerun.serve() Serve log-data over WebSockets and serve a Rerun web viewer over HTTP.
rerun.spawn() Spawn a Rerun Viewer, listening on the given port.
rerun.memory_recording() Streams all log-data to a memory buffer.
rerun.notebook_show() Output the Rerun viewer in a notebook using IPython IPython.core.display.HTML.
rerun.legacy_notebook_show() Output the Rerun viewer in a notebook using IPython IPython.core.display.HTML.

Logging functions

Function Description
rerun.log() Log data to Rerun.
rerun.log_file_from_path() Logs the file at the given path using all DataLoaders available.
rerun.log_file_from_contents() Logs the given file_contents using all DataLoaders available.

Timeline functions

Function Description
rerun.set_time_sequence() Set the current time for this thread as an integer sequence.
rerun.set_time_seconds() Set the current time for this thread in seconds.
rerun.set_time_nanos() Set the current time for this thread.
rerun.disable_timeline() Clear time information for the specified timeline on this thread.
rerun.reset_time() Clear all timeline information on this thread.

Columnar API

Function Description
rerun.send_columns() Send columnar data to Rerun.
Class Description
rerun.TimeNanosColumn A column of time values that are represented as integer nanoseconds.
rerun.TimeSecondsColumn A column of time values that are represented as floating point seconds.
rerun.TimeSequenceColumn A column of time values that are represented as an integer sequence.

Custom Data

Class Description
rerun.AnyValues Helper to log arbitrary values as a bundle of components.

Clearing Entities

Class Description
rerun.Clear Archetype: Empties all the components of an entity.

Annotations

Class Description
rerun.AnnotationContext Archetype: The annotation context provides additional information on how to display entities.
rerun.AnnotationInfo Datatype: Annotation info annotating a class id or key-point id.
rerun.ClassDescription Datatype: The description of a semantic Class.

Images

Class Description
rerun.DepthImage Archetype: A depth image, i.e. as captured by a depth camera.
rerun.Image Archetype: A monochrome or color image.
rerun.EncodedImage Archetype: An image encoded as e.g. a JPEG or PNG.
rerun.SegmentationImage Archetype: An image made up of integer components.ClassIds.

Video

Class Description
rerun.AssetVideo Archetype: A video binary.
rerun.VideoFrameReference Archetype: References a single video frame.

Plotting

Class Description
rerun.BarChart Archetype: A bar chart.
rerun.Scalar Archetype: A double-precision scalar, e.g. for use for time-series plots.
rerun.SeriesLine Archetype: Define the style properties for a line series in a chart.
rerun.SeriesPoint Archetype: Define the style properties for a point series in a chart.

Spatial Archetypes

Class Description
rerun.Arrows3D Archetype: 3D arrows with optional colors, radii, labels, etc.
rerun.Arrows2D Archetype: 2D arrows with optional colors, radii, labels, etc.
rerun.Asset3D Archetype: A prepacked 3D asset (.gltf, .glb, .obj, .stl, etc.).
rerun.Boxes2D Archetype: 2D boxes with half-extents and optional center, colors etc.
rerun.Boxes3D Archetype: 3D boxes with half-extents and optional center, rotations, colors etc.
rerun.Ellipsoids3D Archetype: 3D ellipsoids or spheres.
rerun.LineStrips2D Archetype: 2D line strips with positions and optional colors, radii, labels, etc.
rerun.LineStrips3D Archetype: 3D line strips with positions and optional colors, radii, labels, etc.
rerun.Mesh3D Archetype: A 3D triangle mesh as specified by its per-mesh and per-vertex properties.
rerun.Points2D Archetype: A 2D point cloud with positions and optional colors, radii, labels, etc.
rerun.Points3D Archetype: A 3D point cloud with positions and optional colors, radii, labels, etc.

Tensors

Class Description
rerun.Tensor Archetype: An N-dimensional array of numbers.

Text

Class Description
rerun.LoggingHandler Provides a logging handler that forwards all events to the Rerun SDK.
rerun.TextDocument Archetype: A text element intended to be displayed in its own text box.
rerun.TextLog Archetype: A log entry in a text log, comprised of a text body and its log level.

Transforms and Coordinate Systems

Class Description
rerun.DisconnectedSpace Archetype: Spatially disconnect this entity from its parent.
rerun.Pinhole Archetype: Camera perspective projection (a.k.a. intrinsics).
rerun.Transform3D Archetype: A transform between two 3D spaces, i.e. a pose.
rerun.InstancePoses3D Archetype: One or more transforms between the current entity and its parent. Unlike archetypes.Transform3D, it is not propagated in the transform hierarchy.
rerun.ViewCoordinates Archetype: How we interpret the coordinate system of an entity/space.
rerun.Scale3D Component: A 3D scale factor.
rerun.Quaternion Datatype: A Quaternion represented by 4 real numbers.
rerun.RotationAxisAngle Datatype: 3D rotation represented by a rotation around a given axis.

Interfaces

Class Description
rerun.AsComponents Describes interface for interpreting an object as a bundle of Components.
rerun.ComponentBatchLike Describes interface for objects that can be converted to batch of rerun Components.
rerun.ComponentColumn A column of components that can be sent using send_columns.

Blueprint

Class Description
rerun.blueprint.Blueprint The top-level description of the viewer blueprint.
rerun.blueprint.BlueprintPart The types that make up a blueprint.
rerun.blueprint.Container Base class for all container types.
rerun.blueprint.ContainerLike A type that can be converted to a container.
rerun.blueprint.Horizontal A horizontal container.
rerun.blueprint.Vertical A vertical container.
rerun.blueprint.Grid A grid container.
rerun.blueprint.Tabs A tab container.
rerun.blueprint.SpaceView Base class for all space view types.
rerun.blueprint.BarChartView View: A bar chart view.
rerun.blueprint.Spatial2DView View: For viewing spatial 2D data.
rerun.blueprint.Spatial3DView View: For viewing spatial 3D data.
rerun.blueprint.TensorView View: A view on a tensor of any dimensionality.
rerun.blueprint.TextDocumentView View: A view of a single text document, for use with archetypes.TextDocument.
rerun.blueprint.TextLogView View: A view of a text log, for use with archetypes.TextLog.
rerun.blueprint.TimeSeriesView View: A time series view for scalars over time, for use with archetypes.Scalar.
rerun.blueprint.BlueprintPanel The state of the blueprint panel.
rerun.blueprint.SelectionPanel The state of the selection panel.
rerun.blueprint.TimePanel The state of the time panel.

Dataframe

Function Description
rerun.dataframe.load_archive() Load a rerun archive from an RRD file.
rerun.dataframe.load_recording() Load a single recording from an RRD file.
Class Description
rerun.dataframe.ComponentColumnDescriptor The descriptor of a component column.
rerun.dataframe.ComponentColumnSelector A selector for a component column.
rerun.dataframe.IndexColumnDescriptor The descriptor of an index column.
rerun.dataframe.IndexColumnSelector A selector for an index column.
rerun.dataframe.Recording A single Rerun recording.
rerun.dataframe.RecordingView A view of a recording restricted to a given index, containing a specific set of entities and components.
rerun.dataframe.RRDArchive An archive loaded from an RRD.
rerun.dataframe.Schema The schema representing a set of available columns.
rerun.dataframe.AnyColumn A type alias for any column-like object.
rerun.dataframe.AnyComponentColumn A type alias for any component-column-like object.
rerun.dataframe.ComponentLike A type alias for a component-like object used for content-expressions and column selectors.
rerun.dataframe.ViewContentsLike A type alias for specifying the contents of a view.

Script Helpers

Function Description
rerun.script_add_args() Add common Rerun script arguments to parser.
rerun.script_setup() Run common Rerun script setup actions. Connect to the viewer if necessary.
rerun.script_teardown() Run common post-actions. Sleep if serving the web viewer.

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.