ParaView Plugin

Download

The platform independent source code to the VisTrails plugin for ParaView is available for download from SourceForge under the GPL v.2

Installation

There are three components to the VisTrails plugin for ParaView. First, a patch to the ParaView source code is required, since ParaView does not provide the necessary access to its undo stack by default. Second, there is a standard ParaView plugin that will capture the actions that the user performs. Third, there is a version of VisTrails that has been adapted to interface with ParaView.

ParaView Patch

Since access to the data structures required by the plugin are not provided by default in the ParaView, it must be patched and compiled from source for the VisTrails plugin to work. The source code is not included in the distribution, but can be downloaded from here. Since there has been development on the undo stack in ParaView between the latest release, there are two patches available inside the 'patches' subdirectory of the distribution:

• ParaView-3.4.0.patch, for the latest release (3.4)
• ParaView-dev.patch, for the current cvs version

These patches can be installed with (use Cygwin on Windows):

cd .../path/to/paraview/code/
patch -p0 < .../dist/patches/ParaView-xxx.patch

The BULID_SHARED_LIBS CMake variable must be set to ON, and ParaView can then be compiled as normal.

Plugin

The source code to the ParaView plugin is located in the 'plugin' subdirectory of the distribution. The plugin, like ParaView itself, uses CMake to generate Visual Studio project files and make files. You may need to set the ParaView_DIR CMake variable to point to your ParaView source directory. The plugin can then be compiled, which creates 'VisTrails.dll' on Windows, and 'libVisTrails.so' on Linux. This can be loaded manually from within ParaView, or it can be copied to the ParaView plugins directory so it automatically gets loaded on startup.

VisTrails

A version of VisTrails that has been adapted to run along side ParaView is located in the 'vistrails' subdirectory of the distribution. Python 2.5 is required to run VisTrails. No compiling is necessary, though it must be placed in the correct directory so that the plugin can find it:

cd .../path/to/paraview/executable/
mkdir plugins
cp -r .../dist/vistrails ./plugins/

Usage

With the VisTrails plugin loaded, ParaView may be used as normal. As the user performs actions, they are recorded by VisTrails in the Provenance Recorder window. ParaView pipelines can be loaded simply by clicking on the desired version. Currently, when data files are loaded in ParaView, VisTrails records the absolute filename. Therefore, whenever the pipeline is replayed, all of the data files must be available in the same location.

The user may load ParaView state files, but state loads cannot be undone. When a pipeline that is higher in the version tree is selected, playback must begin at the root, which may be slow. Like data files, the absolute path of state files are stored by VisTrails, so replaying of the state load requires that the file remains in the same place and unchanged.

VisTrails .vt files can be saved and loaded from the Provenance Recorder window, which will include the current state, as well as all previous states that have been explored. State files can also be saved from ParaView, and loaded into instances that do not have the VisTrails plugin loaded.

Most view state changes are not recorded by the plugin. When loading a .vt file, you may need to 'Zoom To Data' for a good view.

Known issues

• The plugin has only been tested with a local ParaView server configuration.
• When loading ParaView with VisTrails already running, VisTrails captures some of the initialization of ParaView. This is not standard usage, and this has not been seen when the ParaView plugin spawns the VisTrails process itself. However, it is not inconcievable that it could happen. When the Provenance Recorder window opens, it should only have a single empty oval in it. If it has several pipelines already in it, simply create a new VisTrail.
• Only actions that are placed on the undo stack and state loads are captured. Other actions that may be performed that cannot be undone will not be captured, and will not be replayed correctly when navigating the version tree.