Skip to content
forked from rerun-io/rerun

Visualize streams of multimodal data. Fast, easy to use, and simple to integrate. Built in Rust using egui.

License

Notifications You must be signed in to change notification settings

ZeroXClem/rerun

 
 

Repository files navigation

Build time aware visualizations of multimodal data

Use the Rerun SDK (available in Python, Rust, and soon C++) to log data like images, tensors, point clouds, and text. Logs are streamed to the Rerun Viewer for live visualization or to file for later use.

import rerun as rr  # pip install rerun-sdk

rr.init("rerun_example_app")

rr.connect()  # Connect to a remote viewer
# rr.spawn()  # Spawn a child process with a viewer and connect
# rr.save("recording.rrd")  # Stream all logs to disk

# Associate subsequent data with 42 on the “frame” timeline
rr.set_time_sequence("frame", 42))

# Log colored 3D points to the entity at `path/to/points`
rr.log("path/to/points", rr.Points3D(positions, colors=colors))
…

Rerun Viewer

Getting started

  • Python: pip install rerun-sdk or on conda
  • Rust: cargo add rerun
  • C / C++: Coming soon

Rerun Viewer binary

Both the Python and Rust library can start the Rerun Viewer, but to stream log data over the network or load our .rrd data files you also need the rerun binary.

It can be installed with pip install rerun-sdk or with cargo install rerun-cli.

You should now be able to run rerun --help in any terminal.

Documentation

Status

We are in active development. There are many features we want to add, and the API is still evolving. Expect breaking changes!

Some shortcomings:

  • Big points clouds (1M+) are slow (#1136)
  • The data you want to visualize must fit in RAM.
  • The Rust library takes a long time to compile
    • We have way too many big dependencies, and we are planning on improving the situation (#1316)

Business model

Rerun uses an open-core model. Everything in this repository will stay open source and free (both as in beer and as in freedom). In the future, Rerun will offer a commercial product that builds on top of the core free project.

The Rerun open source project targets the needs of individual developers. The commercial product targets the needs specific to teams that build and run computer vision and robotics products.

Development

Installing a pre-release Python SDK

  1. Download the correct .whl from GitHub Releases
  2. Run pip install rerun_sdk<…>.whl (replace <…> with the actual filename)
  3. Test it: rerun --version

About

Visualize streams of multimodal data. Fast, easy to use, and simple to integrate. Built in Rust using egui.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 80.0%
  • Python 12.9%
  • C++ 3.8%
  • WGSL 1.7%
  • HTML 0.6%
  • Shell 0.2%
  • Other 0.8%