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/nerfstudio-project/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

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.11.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

viser-0.0.11-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for viser-0.0.11.tar.gz
Algorithm Hash digest
SHA256 5026cb3c086c9193ab5524a0d826bfa07ecb0574bce20a7c0dbe6de4785d0512
MD5 79fc604b3d5c993cee65cc8c14827ce3
BLAKE2b-256 4359359d243b289edbfeed4984036c074135893ed2f8ea6eff95bb5a8ca6923d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for viser-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 7d4864c957557ec79d8f3024695951674fc11bb92b8deb59e15a4b7e606ef721
MD5 7481f8e3b655eb7f1de8c3e1d9f01106
BLAKE2b-256 a43c0df338c76dc5fac6bde9c0bd627336fc0e0985c6c5a7b97ae0e579dea1f5

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