ContextQMD
Back to Rerun

Getting Started

docs/content/getting-started.md

0.32.12.3 KB
Original Source

Rerun helps robotics and Physical AI teams iterate faster: log from any sensor, visualize in the Viewer, and query with dataframes — across one recording or many.

Installation

pip install rerun-sdk bundles the SDK (log/query from code) and the Viewer (visualizer app). For Rust, C++, see Install Rerun and Set up a project.

Open the Viewer

rerun launches the Viewer. Pass a file to open it directly:

bash
rerun path/to/recording.rrd

Supports .rrd, .mcap, and more. Also available in-browser at rerun.io/viewer.

Scale across many recordings

Rerun's catalog organizes recordings as queryable segments. The workflow: log (or convert) data to an .rrd, start a catalog server (or connect to an existing one if using the commercial Rerun Hub), register the .rrd as a segment, then visualize and query across recordings.

Log

Save data to an .rrd see Log and Ingest for more details. If you already have data in another format see our how-to for various examples converting to .rrd.

snippet: tutorials/getting_started_log

Start a catalog server

rerun server starts a local catalog on port 51234 (use Rerun Hub for persistent, multi-user storage), then connect from your code:

bash
rerun server

snippet: tutorials/getting_started[setup]

Ingest

Register an .rrd with a dataset so it shows up as a queryable segment.

snippet: tutorials/getting_started[ingest]

Visualize

Point the Viewer at your server to browse every recording in the catalog. See Configure the Viewer.

bash
rerun rerun+http://127.0.0.1:51234

Query

Query the catalog into a DataFusion DataFrame. See Query and Transform.

snippet: tutorials/getting_started[query]

If you're stuck