/visualizer

The ParaViewWeb Visualizer application which can be used standalone or as a component within another web context.

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Build Status Dependency Status semantic-release npm-download npm-version-requirement node-version-requirement

Goal

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

Pre-requisit

You need ParaView 5.2+ application which can be downloaded here.

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

Development

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

$ git clone https://github.com/Kitware/visualizer.git
$ 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:

$ 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.

Documentation

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

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.