README - Rerun — ContextQMD

<picture> <source media="(max-width: 480px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/480w.png"> <source media="(max-width: 768px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/768w.png"> <source media="(max-width: 1024px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/1024w.png"> <source media="(max-width: 1200px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/1200w.png"> </picture>

An example visualizing an analog clock with hour, minute and seconds hands using Rerun Arrow3D primitives.

Used Rerun types

Boxes3D, Points3D, Arrows3D

Logging and visualizing with Rerun

The visualizations in this example were created with the following Rerun code:

The clock's frame is logged as a 3D box using Boxes3D archetype.

python

rr.log(
   "world/frame",
   rr.Boxes3D(half_sizes=[LENGTH_S, LENGTH_S, 1.0], centers=[0.0, 0.0, 0.0]),
   static=True,
)

Then, the positions and colors of points and arrows representing the hands of a clock for seconds, minutes, and hours are logged in each simulation time. It first sets the simulation time using timelines, calculates the data for each hand, and logs it using Points3D and Arrows3D archetypes. This enables the visualization of the clock's movement over time.

python

for step in range(steps):
   rr.set_time("sim_time", duration=t_secs)

   # … calculating seconds …
   rr.log("world/seconds_pt", rr.Points3D(positions=point_s, colors=color_s))
   rr.log("world/seconds_hand", rr.Arrows3D(vectors=point_s, colors=color_s, radii=WIDTH_S))

   # … calculating minutes …
   rr.log("world/minutes_pt", rr.Points3D(positions=point_m, colors=color_m))
   rr.log("world/minutes_hand", rr.Arrows3D(vectors=point_m, colors=color_m, radii=WIDTH_M))

   # … calculating hours …
   rr.log("world/hours_pt", rr.Points3D(positions=point_h, colors=color_h))
   rr.log("world/hours_hand", rr.Arrows3D(vectors=point_h, colors=color_h, radii=WIDTH_H))

Run the code

To run this example, make sure you have the Rerun repository checked out and the latest SDK installed:

bash

pip install --upgrade rerun-sdk  # install the latest Rerun SDK
git clone [email protected]:rerun-io/rerun.git  # Clone the repository
cd rerun
git checkout latest  # Check out the commit matching the latest SDK release

Install the necessary libraries specified in the requirements file:

bash

pip install -e examples/python/clock

To experiment with the provided example, simply execute the main Python script:

bash

python -m clock  # run the example

If you wish to customize it, explore additional features, or save it use the CLI with the --help option for guidance:

bash

python -m clock --help