vuer An Event-Driven, Declarative Visualization Framework for Physical AI
Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. It is
VR and AR ready, and can be run on mobile devices. To get started, just run:
```shell
pip install 'vuer==0.1.6'
```
> **Running Vuer from the Browser**
>
> Vuer can run directly in the browser via PyScript and Pyodide. Server dependencies are auto-excluded on Emscripten:
>
> import micropip
> await micropip.install("vuer")
> from vuer.schemas import Scene, Box, Urdf
> **Note for Mac Users**
>
> If you encounter build issues with `msgpack` on older systems, you may need gcc@11:
>
> brew install gcc@11
>
> Modern versions of macOS should work with the pre-built wheels.
Here is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples,
please refer to the [examples](examples/meshes/mesh_loading.md) page.
```python
from vuer import Vuer
from vuer.schemas import DefaultScene, Urdf, OrbitControls
app = Vuer()
@app.spawn(start=True)
async def main(sess):
sess.set @ DefaultScene(
Urdf(src="https://raw.githubusercontent.com/nasa-jpl/m2020-urdf-models/main/rover/m2020.urdf"),
up=[0, 0, -1], # Z-down coordinate system
bgChildren=[OrbitControls(key="OrbitControls")]
)
await sess.forever()
```
Vuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.
- light-weight and performant
- VR and AR ready
- has a strong community support
- Hackable and extensible
- Open source, licensed under MIT
## 🤖 Using Vuer with Claude Code
Vuer includes a [Claude Code skill](https://github.com/vuer-ai/vuer-skill) that teaches Claude how to use the library
effectively. To import, run in Claude Code:
```
/plugin marketplace add vuer-ai/vuer-skill
/plugin install vuer@vuer-ai-vuer-skill
```
See the [full guide](guides/claude_skill.md) for more details.
To get a quick overview of what you can do
with
vuer, check out the following:
- take a look at the basic tutorial or the tutorial for robotics:
- [Introduction to Key Vuer Concepts](https://docs.vuer.ai/en/latest/tutorials/basics.html)
- browse the example gallery [here](https://docs.vuer.ai/en/latest/examples/meshes/mesh_loading.html)
- try the demo showing a Unitree Go1 robot in front of a
staircase [here](https://docs.vuer.ai/en/latest/examples/urdf_go1_stairs.html)
For more details:
- A full list of visualization
components: [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).
- A full list of data types: [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.html).
- [Quick Start](quick_start.md)
- [Report Issues](https://github.com/vuer-ai/vuer/issues?q=is:issue+is:closed)
- [Constructing A Scene](guides/first_3d_scene/01_constructing_a_scene.md)
- [Materials & Textures](guides/first_3d_scene/02_materials_and_textures.md)
- [Camera Control](guides/first_3d_scene/03_camera_control.md)
- [Lights](guides/first_3d_scene/04_lights.md)
- [Render Modes](guides/first_3d_scene/05_render_modes.md)
- [Session API](guides/session_apis.md)
- [Static Files & Hot Loading](guides/static_files.md)
- [Python Client Connection](guides/client_connection.md)
- [Using Vuer with Claude Code](guides/claude_skill.md)
- [CLI Plugin System](guides/cli.md)
- [Client (vuer.client)](api/client.md)
- [Workspace (vuer.workspace)](api/workspace.md)
- [Components (vuer.schemas)](api/schemas.md)
- [Events (vuer.events)](api/events.md)
- [Real-Time Collab (vuer.rtc)](rtc/README.md)
- [Scene Generation (OpenAI Sora)](gaussian_splatting/openai_sora.md)
- [Gaussian Splatting](gaussian_splatting/09_gaussian_splats.md)
- [Gaussian Splatting (VR)](gaussian_splatting/10_gaussian_splats_vr.md)
- [SplatMesh(sparkjs)](examples/23_spark.md)
- [basics](tutorials/basics.md)
- [robotics](tutorials/robotics.md)
- [README](tutorials/camera/README.md)
- [physics](tutorials/physics.md)
- [Detecting When Assets Have Been Loaded](tutorials/obj_loading.md)
- [MuJoCo Interactive Simulator](tutorials/mujoco_interactive_simulator.md)
- [Components](components/index.md)
- [Examples](examples/index.md)
- [Module (vuer)](api/vuer.md)
- [Types (vuer.types)](api/types.md)
- [Server Base (vuer.base)](api/base.md)
- [Coordinates (vuer.frame)](api/frame.md)
- [Serialization (vuer.serdes)](api/serdes.md)