For documentation see the interface document.
To get started, first run npm install
.
Useful npm commands:
npm run build # build the library to dist/vcs.js
npm run build-continuous # build the library to dist/vcs.js and rebuild after changes
npm run test # run all tests
npm run test:serve # start test service (runs as files change)
npm run demo # serve the demo page at http://localhost:8080/demo/
While serving tests, you can debug them in the browser at http://localhost:9876/debug.html. This will also serve the coverage results at http://localhost:9876/coverage/index.html.
Executing the demo requires a running vtkweb service, which is assumed to exist at ws://localhost:9000/ws.
A basic protocol implementation for demo purposes exists in this repository at scripts/vcs_server
.
You can start the server with the command PYTHONPATH=. vtkpython scripts/vcs-server -p 9000
. Use the --help
argument
for a list of options. After starting the server, you can execute the demo using npm run demo
and
browsing to http://localhost:8080/demo.
If you get an error message refering to WAMP_FEATURES
while building, try running the following:
npm run fix-autobahn
To start the server run vtkpython demo1/vcs_server.py -p 1234
.
For runnig the client, use the same procedure as for vcs.js demo (npm run demo
). If the client for
vcs.js demo is already started, just browse to http://localhost:8080/demo1.
To start the server run vtkpython demo1/vtk_web_cone.py -p 1234
To run the client use the same procedure as for vtkweb demo with vcs.
This is used to look at differences between vtkweb with ParaView server and with VTK server.
To start the server run PV_ALLOW_BATCH_INTERACTION=1 ~/projects/ParaView/build/bin/pvbatch pv_server.py -p 1234
To run the client use the same procedure as for vtkweb demo with vcs.