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 -e .[examples]
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.13b0.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

viser-0.0.13b0-py3-none-any.whl (4.4 MB view details)

Uploaded Python 3

File details

Details for the file viser-0.0.13b0.tar.gz.

File metadata

  • Download URL: viser-0.0.13b0.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.15 Darwin/22.1.0

File hashes

Hashes for viser-0.0.13b0.tar.gz
Algorithm Hash digest
SHA256 5ef8d32834209ef4ea92e08d70281f7dadfaef2ddb12927d460380a45acfb37f
MD5 40b3bb9b0d15a8d94fc99a05e9b9ee38
BLAKE2b-256 bda39fbdedf2dc02de03d8a8778887a5bef0b5779560d406ab81bdaa50a706e9

See more details on using hashes here.

File details

Details for the file viser-0.0.13b0-py3-none-any.whl.

File metadata

  • Download URL: viser-0.0.13b0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.8.15 Darwin/22.1.0

File hashes

Hashes for viser-0.0.13b0-py3-none-any.whl
Algorithm Hash digest
SHA256 49a71d79178ece56732f44e3a1463bd4b6a83c48d2e040a90bd5de7830abd88a
MD5 43b7235fca37a27ccb5d71a395859bbd
BLAKE2b-256 eddf789af04196fdf21b0bf6bd644ef07c215aed55aa13602dd2c21baeea11ed

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