Skip to main content

3D visualization helper

Project description

viser

pip install viser   •   [ API Reference ]

pyright mypy typescript pypi


viser is a library for interactive 3D visualization + Python, inspired by tools like Pangolin, rviz, and meshcat.

As a standalone visualization tool, viser features include:

  • Web interface for easy use on remote machines.
  • Python API for sending 3D primitives to the browser.
  • Python-configurable inputs: buttons, checkboxes, text inputs, sliders, dropdowns, gizmos.
  • Support for multiple panels and view-synchronized connections.

The viser.infra backend can also be used to build custom web applications (example: the Nerfstudio viewer). It supports:

  • Websocket / HTTP server management, on a shared port.
  • Asynchronous server/client communication infrastructure.
  • Client state persistence logic.
  • Typed serialization; synchronization between Python dataclass and TypeScript interfaces.

Running examples

# Clone the repository.
git clone https://github.com/brentyi/viser.git

# Install the package.
# You can also install via pip: `pip install viser`.
cd ./viser
pip install -e .

# Run an example.
pip install -r ./examples/requirements.txt
python ./examples/4_gui.py

After an example script is running, you can connect by navigating to the printed URL (default: http://localhost:8080).

Setup (client development)

This is only needed for client-side development. The automatically hosted viewer should be sufficient otherwise.

cd ./viser/viser/client
yarn
yarn start

Demos

Interactive SMPL-X Example

https://user-images.githubusercontent.com/6992947/228734499-87d8a12a-df1a-4511-a4e0-0a46bd8532fd.mov

Interactive NeRF rendering

(code not released)

https://user-images.githubusercontent.com/6992947/232163875-ff788455-f074-4bd3-9154-5330b5ed4733.mov

Project details


Release history Release notifications | RSS feed

This version

0.0.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

viser-0.0.9.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

viser-0.0.9-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file viser-0.0.9.tar.gz.

File metadata

  • Download URL: viser-0.0.9.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.16 Linux/5.15.0-1036-azure

File hashes

Hashes for viser-0.0.9.tar.gz
Algorithm Hash digest
SHA256 76bb56ddbe09377763e4836683f4a356885642fed9b0a9de60bf067b80b486c8
MD5 e258233a3b0d9e17ebb92ba0266f9a87
BLAKE2b-256 cbf5f013f503f5b339d78ad453be61c50acb5961c960d8c771453d6f3817f03c

See more details on using hashes here.

File details

Details for the file viser-0.0.9-py3-none-any.whl.

File metadata

  • Download URL: viser-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.16 Linux/5.15.0-1036-azure

File hashes

Hashes for viser-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0963f2f587326b0dc4345848c5a7e7645e70fa4431ad1dfefcf18c4e24c9d3ef
MD5 45f13b333a7044424f36382b23ac1dbb
BLAKE2b-256 1b1d6ca09c2b3f1755f7c1c93701096fab1a3a63b86935714fcfcc59407d19bd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page