Kitware / visualizer

The ParaViewWeb Visualizer application which can be used standalone or as a component within another web context.
https://kitware.github.io/visualizer/
BSD 3-Clause "New" or "Revised" License
115 stars 28 forks source link

Incorrect syntax to start ParaView Web Visualizer in documentation #99

Closed AlbertoPa closed 3 years ago

AlbertoPa commented 3 years ago

High-level description

The instructions provided in this document https://kitware.github.io/visualizer/docs/index.html to start ParaviewWeb Visualizer on Windows using the paraview installation are not correct.

The document says to use:

$ cd ParaView-5.6.0-Windows-64bit
$ .\bin\pvpython.exe               \
   -m paraview.apps.visualizer      \
   --data "C:\...full_path...\data"  \
   --port 8080

==> Open your browser to http://localhost:8080/

However:

The actual syntax, assuming PowerShell or Windows Terminal are used (if ParaView is ParaView-5.6.2-Windows-msvc2015-64bit, which is the name from the Download page. I am using this version because I initially thought the problem was due to a change due to the version, but it was not the case) is:

PS C:\> cd ParaView-5.6.2-Windows-msvc2015-64bit

PS C:\ParaView-5.6.2-Windows-msvc2015-64bit>& .\bin\pvpython.exe `
.\share\paraview-5.6\web\visualizer\server\pvw-visualizer.py `
--data "C:\Your\Path\ToData\ToVisualize\"  `
-p 8080 `
--load-file <PathToFileToLoadIfNeededToOpenData> `
--content .\share\paraview-5.6\web\visualizer\www

I added --load-file because it is needed in some cases to load data (e.g. with the OpenFOAM data reader). With these changes, everything seems to work.

Environment

Thanks!

jourdain commented 3 years ago

Good catch -m was introduced in PV 5.8.

jourdain commented 3 years ago

To see the plain old syntax you can use this link

AlbertoPa commented 3 years ago

Thanks @jourdain

I have 5.8 on my workstation too, and the -m option still gives the same error. I am not sure what is the reason, but I can reproduce this with any version (latest RC included):

image

jourdain commented 3 years ago

The latest RC are for 5.10 not 5.8. Otherwise I might be miss remembering it could have been 5.9. To me it was just to say a "while back".

AlbertoPa commented 3 years ago

My bad, you are right: it works in 5.10. Sorry about that.