launcher configuration file for vtk_server.py

[guozhi72]

Hi,
Want to ask how to prepare configuration file to launch vtk_server.py at https://kitware.github.io/vtk-js/examples/RemoteView.html
I spend quite a lot of time to search and found out
1, I need to run python.exe some_folder/wslink/launcher.py laucher.config.
2, and I know on client side, java script, I need to give url using applition name instead of fixed port number.
But I don't really understand the example config file in launder.py:
1, for endpoint below, should I still give paraview

    "configuration": {
        "host" : "localhost",
        "port" : 8080,
        "endpoint": "paraview",                   // SessionManager Endpoint
        "content": "/.../www",                    // Optional: Directory shared over HTTP
        "proxy_file" : "/.../proxy-mapping.txt",  // Proxy-Mapping file for Apache
        "sessionURL" : "ws://${host}:${port}/ws", // ws url used by the client to connect to the started process
        "timeout" : 25,                           // Wait time in second after process start

2, for propeties: how many below should I give? I guess only I can skip for paraview related.

"properties" : {
"vtkpython" : "/.../VTK/build/bin/vtkpython",
"pvpython" : "/.../ParaView/build/bin/pvpython",
"vtk_python_path": "/.../VTK/build/Wrapping/Python/vtk/web",
"pv_python_path": "/.../ParaView/build/lib/site-packages/paraview/web",
"plugins_path": "/.../ParaView/build/lib",
"dataDir": "/.../path/to/data/directory"
},
Based on my searched, I maybe able to debug launer.py to continue to try, but can somebody help of provide one configure example which can launch vtk_server.py. I imagine it will be much less the the example in launcher.py.
Best

[jourdain]

Well if you were using trame-cookiecutter, you will get a docker bundle already done for you that take care of that part and more.

To answer your question the endpoint should still be "paraview" and the "properties" group can be empty. Those are just to reduce your command line sections. Also you should run it like python -m wslink.launcher /path/to/config.json.

[guozhi72]

Hi, Sebastian:

Thanks for your reply.
I will try to use trame-cookiecutter later for sure. But it looks almost self contained. But I saw build.sh, and run.sh, so that implies I have to be in unix system. I imagine if I try on windows, anything can happened.

Redring using javascript and vtkweb, kitware has example. But if can add some example how to lauch vtk_server.py for multiple user that would be wonderful.

Another example is when I launch trame example, saw message "Note that for multi-users you need to use and configure a launcher." Totally have no idea what to do at the beginning. After spend a few weeks, on vtk.web, and trame, I guess I many need to run wsline/laucher.py mylauncer.config. But just still couldn't find an example. Have to try.

Best

[jourdain]

So the scripts are just command line for docker. On windows, you will just have to run those command by hand but they will work.

For the multi user example, we highly recommend using docker. We provide a lot of doc on that subject but still not enough for many users. The default launcher config that get printed by default is already a great working example.
Basically using the launcher without Apache is also very limited as it will use different port underneath rather than a single one like http or https.

Like I said, if you want to use a trame app for multiple users, you need something special. The cookiecutter give you that option. You also even have that example as well.

[guozhi72]

Hi, Sebastian:

Thanks for all the information. Trame did have big advantages. Though I did not test the deployment, I feel trame deployment documentation is solid.

But java script( for examle angular ) as UI, do visualization using vtk remote rendering also had it clearly advantage.
Do you have a docker example, which if I put vtk_server.py, then docker can handle mutiple user or at least multiple connection case.

[jourdain]

Just use the trame bundle. This is the same thing. It was just cleaned up and streamlined to align with trame philosophy.

[guozhi72]

do you mean I can use trame bundle to depoly : https://kitware.github.io/paraviewweb/examples/RemoteRenderer.html, this example?

[jourdain]

yes... You will need to change the client code to not use a fixed session url since that will be given to it by the launcher and you will have to adjust the command line or make it a python package for its server side.

You can find some info on how to use the trame docker here

[guozhi72]

for web_cone, https://kitware.github.io/paraviewweb/examples/RemoteRenderer.html. I hard code 1234 in client, and not using launcher, it works. If use launcher, I got below error, I have the command I run, config file and client code at the end of letter( why I got 9999/paraview, should not be 8080/paraview)

    Failed to load resource: the server responded with a status of 404 (Not Found)

:9999/paraview/:1

######## command I run
C:\dev_azure\server_render_angular_client\server.env\Scripts\python.exe C:\dev_azure\server_render_angular_client\server\launcher.py launch.config

launch.config :

{
// ===============================
// General launcher configuration
// ===============================

    "configuration": {
        "host" : "localhost",
        "port" : 8080,
        "endpoint": "paraview",                   // SessionManager Endpoint
        "sessionURL" : "ws://${host}:${port}/ws", // ws url used by the client to connect to the started process
        "timeout" : 25,                           // Wait time in second after process start
        "log_dir" : "C:\\dev_azure\\server_render_angular_client\\server\\log",             // Directory for log files
        "proxy_file" : "",
        "fields" : ["file", "host", "port"]
        },

    "resources" : [ { "host" : "localhost", "port_range" : [9001, 9003] } ],

    "properties" : {

    },

    "apps" : {
        "cone" : {
            "cmd" : [
                "C:\\dev_azure\\server_render_angular_client\\server\\.env\\Scripts\\python.exe",
                "C:\\dev_azure\\server_render_angular_client\\server\\vtk_server.py",
                "--port",
                "$port" ],
            "ready_line" : "Starting factory"
        }
    }

}

#### 222222    client code( pure java script

import 'normalize.css';

import SmartConnect from 'wslink/src/SmartConnect';

import RemoteRenderer from 'paraviewweb/src/NativeUI/Canvas/RemoteRenderer';
import SizeHelper from 'paraviewweb/src/Common/Misc/SizeHelper';
import ParaViewWebClient from 'paraviewweb/src/IO/WebSocket/ParaViewWebClient';

document.body.style.padding = '0';
document.body.style.margin = '0';

const divRenderer = document.createElement('div');
document.body.appendChild(divRenderer);

divRenderer.style.position = 'relative';
divRenderer.style.width = '100vw';
divRenderer.style.height = '100vh';
divRenderer.style.overflow = 'hidden';

// const config = { sessionURL: 'ws://localhost:1234/ws' };
const config = { application: 'cone' };
const smartConnect = SmartConnect.newInstance({ config });
smartConnect.onConnectionReady((connection) => {
const pvwClient = ParaViewWebClient.createClient(connection, [
'MouseHandler',
'ViewPort',
'ViewPortImageDelivery',
]);
const renderer = new RemoteRenderer(pvwClient);
renderer.setContainer(divRenderer);
renderer.onImageReady(() => {
console.log('We are good');
});
window.renderer = renderer;
SizeHelper.onSizeChange(() => {
renderer.resize();
});
SizeHelper.startListening();
});
smartConnect.connect();

[guozhi72]

I just could not find any example to make the web_con remote rendering work using launcher for multiple connection.

And since it is server-side rendering, multiple connection is mandatory. Surprisingly, could not find single example

[guozhi72]

If I check the browser, I got this. Of course 9999 cannot find.

Request URL:
http://localhost:9999/paraview/
Request Method:
POST
Status Code:
404 Not Found
Remote Address:
[::1]:9999
Referrer Policy:
strict-origin-when-cross-origin

[guozhi72]

I will try your suggested. It looks clear, I must be able to produce. After that, I will get back to you .
Thanks

[guozhi72]

Hi, @sebastien:
I follow each step you directed, still could not make it works.

my folder structure is as

I modify the html file and rename to index.html as shown:

my config is as:

I run python launcher as

I got errror message

the log is

Good thing is I can see the individual server is launched, and get an idea. Can you see what is wrong?

[jourdain]

You still have / in the cmd section while you properly fixed the current_dir by using \\.
The problem was even shown in the error message.

[guozhi72]

thanks for your help, I change the path correctly. But still got error.
here is the error:

Here is the log

Thanks for your help.

[jourdain]

The log you are sharing is not the useful one. You need to look at the one from the created session.

[jourdain]

Since you can't find the documentation I will list some links below.

• http://kitware.github.io/paraviewweb/docs/multi_user_setup.html
• http://kitware.github.io/paraviewweb/docs/launcher_api.html
• http://kitware.github.io/paraviewweb/docs/python_launcher.html
• http://kitware.github.io/paraviewweb/docs/launching_examples.html
• https://github.com/Kitware/paraviewweb-demo/
• https://github.com/Kitware/paraviewweb-demo/blob/master/pvw/launcher/config.json
• https://github.com/hydroframe/SandTank/blob/master/deploy/pvw/launcher/config.json

[guozhi72]

I mean an example for launching multiple web cone

[jourdain]

Well build that cone example for production and serve the static html using the launcher via the "content": "/path/to/static-html/ property and that's it.

[jourdain]

If you understood what you were doing by reading the guides, you would not need an example.

[guozhi72]

Close