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[all]==0.0.71'
```
> **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
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)
- [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)
- [Primitive Geometries](components/category_primitives.md)
- [3D Model](components/category_3d_models.md)
- [Gaussian Splatting](components/category_gaussian_splatting.md)
- [Interaction](components/category_interactive.md)
- [Cameras](components/category_camera_view.md)
- [Helper](components/category_helpers.md)
- [Text](components/category_text.md)
- [Background](components/category_background.md)
- [Control](components/category_organization.md)
- [meshes](examples/meshes.md)
- [point clouds](examples/point_clouds.md)
- [urdf go1 stairs](examples/urdf_go1_stairs.md)
- [spline frustum](examples/spline_frustum.md)
- [Hand, Controller and Body Tracking](examples/vr_ar_xr.md)
- [3DGS from Sora video](examples/openai_sora.md)
- [3D Text, 2D Text, and Billboard](examples/visualization/3d_text.md)
- [Depth Texture](examples/visualization/depth_texture.md)
- [background environment](examples/background_environment.md)
- [pointer](examples/pointer.md)
- [vuer](api/vuer.md)
- [vuer.frame](api/frame.md)
- [vuer.base](api/base.md)
- [vuer.types — Type Interafce](api/types.md)
- [vuer.events — Event Types](api/events.md)
- [vuer.schemas — Components](api/schemas.md)
- [vuer.serdes — Serialization](api/serdes.md)