The simplest example is minimal. You may want to start there!
Read more about our examples at https://www.rerun.io/docs/getting-started/examples.
First install the Rerun Python SDK with pip install rerun-sdk
Each example comes with its own set of dependencies listed in a requirements.txt file. For example, to install dependencies and run the toy car example (which doesn't need to download any data) run:
pip install -r examples/python/car/requirements.txt
examples/python/car/main.pyYou can also install all dependencies needed to run all examples with:
pip install -r examples/python/requirements.txtBy default, the examples spawn a Rerun Viewer and stream log data to it.
You can instead save the log data to an .rrd file using examples/python/car/main.py --save data.rrd. You can then open that .rrd file with rerun data.rrd.
(rerun is an alias for python -m rerun).
NOTE: .rrd files do not yet guarantee any backwards or forwards compatibility. One version of Rerun will likely not be able to open an .rrd file generated by another Rerun version.
Some examples will download a small datasets before they run. They will do so the first time you run the example. The datasets will be added to a subdir called dataset, which is in the repo-wide .gitignore.
Feel free to open a PR to add a new example!
See CONTRIBUTING.md for details on how to contribute.