Skip to main content

URDF -> Rerun plugin

This is an example data-loader plugin that lets you view URDF files in the Rerun Viewer. It uses the external data loader mechanism to add this capability to the viewer without modifying the viewer itself.

https://github.com/rerun-io/rerun-loader-python-example-urdf/assets/9785832/51659bee-330d-4058-980d-414d2e4e63bb

External data loaders are executables that are available to the Rerun Viewer via the PATH variable, with a name that starts with rerun-loader-.

This example is written in Python, and uses urdf_parser_py to read the files. ROS package-relative paths support both ROS 1 and ROS 2-based resolving.

Installing the Rerun Viewer

The simplest option is just:

pip install rerun-sdk==0.20.3

Read this guide for more options.

Installing the plugin

Installing pipx

The most robust way to install the plugin to your PATH is using pipx.

If you don't have pipx installed on your system, you can follow the official instructions here.

Installing the plugin with pipx

Now you can install the plugin to your PATH using

pipx install git+https://github.com/rerun-io/rerun-loader-python-example-urdf.git
pipx ensurepath

Note: you can use the --python argument to specify the Python interpreter to use with pipx. On unix-like systems --python $(which python) will use the currently active Python.

Make sure it's installed by running it from your terminal, which should output an error and usage description:

> rerun-loader-urdf
usage: rerun-loader-urdf [-h] [--opened-application-id APPLICATION_ID] [--recording-id RECORDING_ID] [--entity-path-prefix ENTITY_PATH_PREFIX] [--static] [--time TIME] [--sequence SEQUENCE] filepath
rerun-loader-urdf: error: the following arguments are required: filepath

Try it out

Download an example URDF file

curl -OL https://github.com/rerun-io/rerun-loader-python-example-urdf/raw/main/example.urdf

Open in the Rerun Viewer

You can either first open the viewer, and then open the file from there using drag-and-drop or the menu>open… dialog, or you can open it directly from the terminal like:

rerun example.urdf

Metadata

Release files for rerun-loader-urdf 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rerun-loader-urdf 0.1.1
File Size Uploaded Provenance Actions
rerun_loader_urdf-0.1.1.tar.gz 38.6 kB Without provenance Details for rerun_loader_urdf-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rerun-loader-urdf 0.1.1
File Interpreter ABI Platform Actions
rerun_loader_urdf-0.1.1-py3-none-any.whl Python 3 none any Details for rerun_loader_urdf-0.1.1-py3-none-any.whl

Total release size: 50.2 kB

Release files / rerun_loader_urdf-0.1.1.tar.gz

Download URL rerun_loader_urdf-0.1.1.tar.gz
Size 38.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0bc3d105052de60986f30e83829b630fc34f2d86d168a70cb98320afda31ea96
BLAKE2b-256 checksum
How to use checksums
0b4fd9a4116dd9a970f5cc10854c9593f3b4963b13cc8392d3a65a8b47c5f9ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.8

Release files / rerun_loader_urdf-0.1.1-py3-none-any.whl

Download URL rerun_loader_urdf-0.1.1-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e7f63cb9a8349cd4f25feca2e2c42ab33bc1b4f7d3e00da21cc811cd82874e4
BLAKE2b-256 checksum
How to use checksums
7d6bbab1062a5173b86b802b60f71970192bbfb55a8e88ace4579553bdb24856
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.8

Security for rerun-loader-urdf 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page