pvw-visualizer

Visualizer

!npm-download
!npm-version-requirement
!node-version-requirement

Goal

Provide a Web based interface to ParaView similar to the ParaView Desktop Qt client.

Documentation

See the documentation for a getting
started guide, advanced documentation, and API descriptions.

Pre-requisite

You will need ParaView, which can be downloaded here. The
table below indicates which versions work together.

| ParaView | Visualizer | Visualizer in PV binary |
|:--------:|:-----------------------------------:|:-----------------------:|
| 5.2 | <= 2.0.17 | 2.0.16 |
| 5.3 | broken on Linux, otherwise <=2.0.20 | 2.0.18 |
| 5.4 | <=2.2.0 | 2.1.4 |
| master | 2.3+ | 2.3.0 |

To install ParaViewWeb-Visualizer for your command line environment,
you will need to have Node which should have NPM.

Installation

``
$ npm install -g pvw-visualizer
`

After installing the package you will get one executable Visualizer with
the following set of options.

`
$ Visualizer

Usage: Visualizer [options]

Options:

-h, --help output usage information
-V, --version output the version number
-p, --port [8080] Start web server with given port
-d, --data [directory] Data directory to serve
-s, --server-only Do not open the web browser

--paraview [path] Provide the ParaView root path to use

--load-file [fileToLoad] File to load using data base path as root
--exclude-regex [excludeRegex] Regular expression for file filtering
--group-regex [groupRegex] Regular expression for grouping files
--plugins [pluginList] List of fully qualified path names to plugin objects to load
--proxies [proxyFile] Path to a file with json text containing filters to load
--no-auto-readers If provided, disables ability to use non-configured readers

--viewport [1x2560x1440] Configure viewport {scale}x{maxWidth}x{maxHeight}
`

Development

To start developing pvw-visualizer, execute the following commands:

`sh
$ git clone https://github.com/Kitware/visualizer.git
$ cd visualizer
$ npm install
$ npm run build
$ npm link
$ Visualizer

Usage: Visualizer [options]

Options:

-h, --help output usage information
-V, --version output the version number
-p, --port [8080] Start web server with given port
-d, --data [directory] Data directory to serve
-s, --server-only Do not open the web browser

--paraview [path] Provide the ParaView root path to use
`

Before you commit, please run:

`sh
$ npm run build:release
``

This creates a minified version of the visualizer JavaScript code in dist/Visualizer.js
which should be added to your commit.

#### Licensing

Visualizer aka ParaViewWeb:Visualizer is licensed under BSD Clause 3.

#### Getting Involved

Fork our repository and do great things. At Kitware,
we've been contributing to open-source software for 15 years and counting, and
want to make Visualizer useful to as many people as possible.