Getting started

Installing from wheel file

Run the following command to install Wis3D.

pip install https://github.com/zju3dv/Wis3D/releases/download/2.0.0/wis3d-2.0.0-py3-none-any.whl

Installing from source

Please refer to https://github.com/zju3dv/Wis3D/tree/main

Verify installation

python -c "from wis3d import Wis3D"

If there is no error, Wis3D has been successfully installed.

Important note

When using Wis3D<2.0.1, please always keep the browser inspector window open and make sure the Disable cache option in Network tab is checked. Otherwise, the browser may not update the visualization correctly.

Quickstart

wis3d_quickstart --host {host}

host: The host address of the web service. Default is localhost.

Running examples

Wis3D provides a complete set of testing data and a simple tutorial. See https://github.com/zju3dv/Wis3D/blob/main/example/test.py for the example code.

Run python example

python example/test.py

Start the web service to get the visualization.

wis3d --vis_dir example/visual --host 0.0.0.0 --port 19090

Open your browser, and enter http://localhost:19090 to see the results.

For more information about how to use Wis3D, please refer to How to use Wis3D.