Difference between revisions of "ParaViewWeb"

From KitwarePublic
Jump to navigationJump to search
Line 13: Line 13:
 
==Getting Started==
 
==Getting Started==
  
More detailed documentation and tutorials will be available soon. Until then, here's how to start a simple local web-server to open data files using ParaView 4.0 binaries.
+
Please refer to the online generated [http://www.paraview.org/ParaView3/Doc/Nightly/www/js-doc/index.html ParaViewWeb documentation]
More informations can also be found here:
+
or the [http://www.paraview.org/ParaView3/Doc/Nightly/www/js-doc/index.html#!/guide/quick_start getting started guide]
* http://www.paraview.org/ParaView3/Doc/Nightly/www/js-doc/index.html
 
* http://www.paraview.org/ParaView3/Doc/Nightly/www/py-doc/index.html
 
 
 
===Starting the web-server===
 
 
 
The generated version of ParaView binaries can be used to execute the following command lines.
 
The files can be downloaded here: http://www.paraview.org/paraview/resources/software.php
 
For OS X, the ParaView binary that is compatible with ParaViewWeb is the one using Python 2.7.
 
 
 
====Linux====
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT
 
> ./bin/pvpython lib/paraview-4.0/site-packages/paraview/pipeline_manager.py --content lib/paraview-4.0/www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
If Nightly binaries are used or any 4.1+ release you should use the following command line
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT
 
> ./bin/pvpython lib/paraview-4.1/site-packages/paraview/web/pv_web_visualizer.py --content share/paraview-4.1/www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
====OsX====
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT/Contents
 
> ./bin/pvpython Python/paraview/pipeline_manager.py --content www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
If Nightly binaries are used or any 4.1+ release you should use the following command line
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT
 
> ./bin/pvpython lib/paraview-4.1/site-packages/paraview/web/pv_web_visualizer.py --content share/paraview-4.1/www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
====Windows====
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT\bin
 
> pvpython.exe ..\lib\paraview-4.0\site-packages\paraview\pipeline_manager.py --content ..\lib\paraview-4.0\www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
If Nightly binaries are used or any 4.1+ release you should use the following command line
 
Although the www directory may be missing in current windows binaries but could be retrieved from the Linux package.
 
 
 
<source lang="bash">
 
> cd $PARAVIEW_ROOT\bin
 
>  pvpython.exe ..\lib\paraview-4.1\site-packages\paraview\web\pv_web_visualizer.py --content share\paraview-4.1\www --port 8080 --data-dir $PARAVIEW_DATA
 
</source>
 
 
 
where:
 
* '''$PARAVIEW_ROOT''' points to path where the ParaView tarball was extracted.
 
* '''$PARAVIEW_DATA''' is path to directory containing data files to test '''(without trailing "/")'''
 
 
 
===Starting the client===
 
 
 
Once the server has started, simply point your web-browser to http://localhost:8080/apps/WebVisualizer/
 
 
 
There is 4 built-in demos in the www directory:
 
* http://localhost:8080/apps/WebVisualizer/
 
* http://localhost:8080/apps/WebFileViewer
 
* http://localhost:8080/apps/DataProber
 
* http://localhost:8080/apps/LiveArticles
 

Revision as of 01:34, 7 December 2013


This document describes ParaViewWeb framework introduced with ParaView 4.0. For earlier version, try this revision.


ParaViewWeb is a collection of components that enables the use of ParaView's visualization and data analysis capabilities within Web applications.

Using the latest HTML 5.0 based technologies, such as WebSocket, and WebGL, ParaViewWeb enables communiation with a ParaView server runnning on a remote visualization node or cluster using a light-weight JavaScript API. Using this API, Web applications can easily embed interactive 3D visualization components. Application developers can write simple Python scripts to extend the server capabilities including creating custom visualization pipelines.

ParaViewWeb makes it possible to extend web-based scientific workflows with ability to visualizate and analyze datasets easily.

More samples and tutorials are forthcoming. In the mean time, one can access the JavaScript and Python API documentation on ParaView website.

Getting Started

Please refer to the online generated ParaViewWeb documentation or the getting started guide