Notebook: minimal example

Overview

Rerun can be used directly within Jupyter notebooks. Many additional environments beyond Jupyter are supported such as Google Colab or VSCode.

You need the separate support package rerun-notebook to use this feature. Typically this is installed using:

pip install "rerun-sdk[notebook]"

In order to show a Rerun Viewer inline within a notebook, you can call:

rr.init("rerun_example_notebook")

rr.log(...)

rr.notebook_show()

This will show the contents of the current global recording stream. Note that the global stream will accumulate data in-memory. You can reset the stream by calling rr.init again to establish a new global context.

As with the other stream viewing APIs (rr.show, rr.connect_grpc, rr.spawn), you can alternatively pass a specific recording instance to notebook_show

rec = rr.RecordingStream("rerun_example_notebook_local")

rec.log(...)
rec.notebook_show()

Running in Jupyter

The easiest way to get a feel for working with notebooks is to use it.

First, install the requirements (this includes Jupyter, the Rerun SDK, and the notebook support package)

pip install -r requirements.txt

Then, open the notebook

jupyter notebook cube.ipynb

Follow along in the browser that opens.

Running in Google Colab

cube_colab.ipynb is a version of this example that runs in Google Colab. Its first cell installs the latest Rerun release and restarts the runtime.

Running in marimo

The same example is available as a marimo notebook:

pip install "rerun-sdk[notebook]" marimo
marimo edit cube_marimo.py

marimo handles messages from the viewer only between cells, so a viewer cannot receive data until the cell that created it has finished. To stream data live, create the viewer in one cell and log to it from a later one.