Difference between revisions of "ParaView"

From KitwarePublic
Jump to navigationJump to search
 
(359 intermediate revisions by 35 users not shown)
Line 1: Line 1:
http://paraview.org/Art/ParaViewBanner.jpg
+
[http://www.example.com link title]<center>[[image:pvsplash1.png]]</center>
  
Welcome to ParaView, an application designed with the need to visualize large data sets in mind.
 
  
==Documentation Topics==
+
 
 +
ParaView is an open-source, multi-platform application designed to visualize data sets of varying sizes from small to very large. The goals of the ParaView project include developing an open-source, multi-platform visualization application that supports distributed computational models to process large data sets. It has an open, flexible, and intuitive user interface. Furthermore, ParaView is built on an extensible architecture based on open standards. ParaView runs on distributed and shared memory parallel as well as single processor systems and has been successfully tested on Windows, Linux, Mac OS X, IBM Blue Gene, Cray XT3 and various Unix workstations and clusters. Under the hood, ParaView uses the Visualization Toolkit as the data processing and rendering engine and has a user interface written using the Qt cross-platform application framework.
 +
 
 +
The goal of this Wiki is to provide up-to-date documentation maintained by the developer and user communities. As such, we welcome volunteers that would like to contribute. If you are interested in contributing to ParaView or to this wiki, please post a message on the ParaView Discourse forum at https://discourse.paraview.org/.
 +
 
 +
'''For new users, download and install the [http://paraview.org/paraview/resources/software.php ParaView binaries] for your local computer, and then read [[The ParaView Tutorial]]. ''' Additional tutorials are located under [[#Books and Tutorials]] below.
 +
 
 +
You can find more information about ParaView on the ParaView web site: http://paraview.org. For more help, including a list of all sources and filters, check out http://paraview.org/paraview/help/documentation.html.
 +
 
 +
==ParaView In Use==
 +
* [[ParaView In Action]]
 +
: Some examples of how ParaView is used
 +
 
 +
* [http://flickr.com/groups/paraview/pool/ ParaView Screenshots]
 +
: Screenshots generated by ParaView
 +
 
 +
* [[ParaView/HPC Installations|HPC Installations]]
 +
: Links to documentation of ParaView installations on various HPC sites
 +
 
 +
== Documentation ==
 +
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
 +
|-
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
|-
 +
|valign="top"|
 +
 
 +
===License===
 +
* [[ParaView/License| ParaView License]]
 +
* [[ParaView/ThirdPartyLicenses | ParaView Third-Party Licenses]]
 +
 
 +
===Compile/Install===
 +
----
 +
* [http://paraview.org/paraview/resources/software.php Download ParaView]
 +
: Instructions for downloading source as well as pre-compiled binaries for common platforms.
 +
* [[ParaView Release Notes]]
 +
: Collection of release notes for official ParaView releases.
 +
* [https://gitlab.kitware.com/paraview/paraview/blob/master/Documentation/dev/git/README.md Git Instructions]
 +
: Git is the revision control system that ParaView uses. If you would like to have the bleeding edge version of ParaView, or you would like to contribute code, this link describes the method you must use to get the code.
 +
* [[ParaView Nightly Binaries]]
 +
: Downloading nightly binaries for development versions of ParaView.
 
* [[ParaView:Build And Install|Building and Installation instructions]]
 
* [[ParaView:Build And Install|Building and Installation instructions]]
* [[ParaView:FAQ|Frequently asked questions]]
+
: Compiling and installing ParaView from source.
* [http://www.kitware.com/products/paraviewguide.html ParaView Guide]
+
* [[ParaView And Mesa 3D]]
* [[ParaView III]]
+
: Building ParaView with [http://www.mesa3d.org Mesa 3D].
 +
* [[ParaView Binaries | ParaView Binaries Build Information]]
 +
: Information about the official ParaView builds and versions of various dependencies used.
 +
* [[ParaView and VTK on Xeon Phi (KNC)]]
 +
: Information on cross compiling ParaView and VTK for Xeon Phi KNC
 +
 
 +
===Server Setup===
 +
----
 +
* [[Setting up a ParaView Server| ParaView Server Setup]]
 +
:Configuring your cluster to act as a ParaView server.
 +
* [[Starting the server| ParaView Server Startup Using GUI]]
 +
:Using the ParaView client to start the servers.
 +
* [[ParaView:Server Configuration| Server Configuration]]
 +
:Customizing server startup and connection processes using XML-based configuration scripts.
 +
* [[ParaView/Distributing Server Configuration Files|Distributing Server Configuration Files]]<font color="green">*new in 3.14</font>
 +
:Strategies for distributing server configuration xmls.
 +
* [[Reverse_connection_and_port_forwarding| Port forwarding]]
 +
:To run ParaView on clusters with head nodes - compute nodes
 +
* [[Configuring Server Environment Using *.pvx XML Files]]
 +
:Configure your cluster environment such as DISPLAY, or Cave settings using *.pvx xml files.
 +
* [http://www.iac.es/sieinvens/siepedia/pmwiki.php?n=HOWTOs.ParaviewInACluster Cluster Configuration to run ParaView]
 +
:A guide for configuring a cluster to run ParaView
 +
 
 +
===Importing Data===
 +
----
 +
* [[Generating data]]
 +
:How to write out data in a format that Paraview understands
 +
* [[Data formats]]
 +
: More information on data formats ParaView supports and how to load them.
 +
* [[Writing ParaView Readers]]
 +
:How to write a VTK reader that will read your data directly into ParaView.
 +
* [[ParaView/ParaView Readers and Parallel Data Distribution|ParaView Readers and Parallel Data Distribution]]
 +
:How data is loaded in parallel for various readers.
 +
 
 +
===Finding Data===
 +
----
 +
* [[Find Data using Queries]] <font color="green">* new in 3.8 </font>
 +
: Selecting and focusing on subset of a dataset using queries.
 +
* [[Data Selection]]
 +
: Selecting and focusing on subset of a dataset.
 +
 
 +
===Analyzing Data===
 +
----
 +
* [[Parameter Study|Parameter Study (Comparative Visualization)]] <font color="green">* improved in 3.8</font>
 +
: Creating visualizations to compare effects for change in parameter(s).
 +
* [[Statistical analysis]]
 +
: Computing statistics and using them to assess datasets.
 +
 
 +
===Animation===
 +
----
 +
* [[Animating legacy VTK file series]]
 +
: Animating file series.
 +
* [[Disconnecting from server while still saving an animation|Unattended saving of animation]]
 +
: Saving animations on the server without client connection.
 +
* [[Animation View]]
 +
: Using ''Animation View'' to setup animations.
 +
* [[Animating the Camera]]
 +
: Creating animations involving camera movements.
 +
 
 +
===Plugins===
 +
----
 +
* [[Plugin HowTo | Extending ParaView Using Plugins]]
 +
:Using and writing new plugins to extend ParaView's functionality.
 +
* [[Extending ParaView at Compile Time]]
 +
:Including extensions into ParaView at compile time.
 +
* [http://pluginwizard.mirarco.org/ Plugin Wizard]
 +
:A simple wizard application developed by MIRARCO that provides boilerplate code for some of the most common plugin types.
 +
* [[User Created Plugins]]
 +
:Please post plugins that you have created that may be useful for other users.
 +
* [[Writing Custom Applications]] <font color="green">* new in 3.8</font>
 +
: Writing custom applications based on ParaView.
 +
* [[ParaView:Plugin Deployment with Development Installs|Plugin Deployment with Development Installs]]
 +
: Building plugins for deployment with Released ParaView binaries.
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 
 +
===Python Scripting===
 +
----
 +
* [[ParaView/Python_Scripting#Getting_Started|Environment Setup]]
 +
: Environment variables to set when using a Python shell besides pvpython/pvbatch.
 +
* [[ParaView/Python Scripting|Python Scripting]] <font color="green">* updated to 3.6</font>
 +
: Scripting ParaView using python
 +
* [[Python Programmable Filter]]
 +
: Generating/Processing data using python.
 +
* [[Python GUI Tools]] <font color="green">* updated for 3.10</font>
 +
: Using the python shell interface in paraview including generating python trace.
 +
* Python [[Python recipes|recipes]] for ParaView
 +
: Collection of python scripts for some common tasks.
 +
 
 +
===GUI Features===
 +
----
 +
* [[Camera and Property Linking]]
 +
: Synchronizing filters, clip planes, camera etc.
 +
* [[Color Palettes]]
 +
: Creating visualizations for Print and Screen.
 +
* [[Colormaps]]
 +
: Details of ParaView's xml colormap file format and collections of colormaps for use with ParaView.  
 +
* [[ParaView/UI/CopyPaste|Copy/Paste Friendly]] <font color="green">* new feature for 3.14</font>
 +
: Using ParaView Copy/Paste inside information tab and spreadsheet view
 +
* [[Custom Filters]]
 +
: Packaging pipelines into a single composite.
 +
* [[ParaView/Image Compressor Configuration|Image Compressor Configuration]]
 +
: How to configure ParaView's image compressor for use during remote rendering.
 +
* [[ParaView/Users_Guide/Memory_Inspector|Memory Inspector Panel]] <font color="green">* updated in 3.98.0 </font>
 +
: Using ParaView's Memory Inspector Panel and its debugging features.
 +
* [[ParaView Settings Files]]
 +
: The locations where ParaView saves settings files (also known as config or configuration files).
 +
* [[ParaView/Properties Panel|Properties Panel]] <font color="green">* updated for 4.0</font>
 +
: Using and customizing the Properties Panel.
 +
* [[Space Navigator]] <font color="green">* new feature for 3.10</font>
 +
: Using ParaView with Space Navigator
 +
* [[Sortable spreadsheet view]] <font color="green">* new feature for 3.10</font>
 +
: What can be done with the spreadsheet column sorting and how it works
 +
* [[ParaView/UI/TextFinder|Text Finder]] <font color="green">* new feature for 3.14</font>
 +
:  Searching in long lists and tables in the ParaView GUI.
 +
* [[Output Messages Window]]
 +
: Design document
 +
 
 +
===Other Features===
 +
----
 +
* [[Restarted Simulation Readers]]
 +
: Loading restarted data for different file formats.
 +
* [[Exporting Scenes]]
 +
: Exporting scenes as VRML, X3D etc.
 +
* [[Backwards compatibility in state files]]
 +
: Backwards compatibility for ParaView state files (*.pvsm).
 +
* [[ParaView/Collaboration| Collaboration]] <font color="green">* new in 3.14</font>
 +
: Information of the changes that have been done undercover to support and improve collaboration.
 +
* [[ParaView/Vector Graphics Export| Vector Graphics Export]] <font color="green">* new in 3.98</font>
 +
: Export publication quality 3D scenes and charts.
 +
* [[ParaView/Equation Rendering| Equation Rendering]] <font color="green">* new in 3.98.1</font>
 +
: Annotating scenes with mathematical equations.
 +
* [[ParaView/Line_Integral_Convolution|Surface LIC]] <font color="green">* updated in 4.1 </font>
 +
: Documentation describing how to configure and use the surface LIC plugin.
 +
* [[Spatio-Temporal Parallelism]] <font color="green">* available in the ParaView Git repository</font>
 +
 
 +
=== Books and Tutorials ===
 +
----
 +
* [https://www.paraview.org/paraview-guide/ The ParaView Guide]
 +
: The official ParaView guide available from Kitware. [[Book Errata]]
 +
: You can download the open-source PDF edition from the [http://www.paraview.org/download/ downloads] page.
 +
*[http://www.paraview.org/ParaView/Doc/Nightly/www/cxx-doc/index.html ParaView API Documentation]
 +
: API documentation auto-generated from the source files.
 +
* [[The ParaView Tutorial]]
 +
: An introductory and comprehensive tutorial.
 +
* [https://www.paraview.org/paraview-downloads/download.php?submit=Download&version=v4.3&type=data&os=all&downloadFile=ParaViewCatalystUsersGuide_v2.pdf ParaView Catalyst User's Guide]
 +
: The official ParaView Catalyst User's Guide v2.0 corresponding to ParaView 4.3.1.
 +
* [[SNL ParaView Tutorials]]
 +
: Beginning and advanced tutorial sets, each presented as 3-hour classes by Sandia National Laboratories
 +
* [[Intel HPC Dev Con ParaView and OSPRay Tutorial]]
 +
: Short course on ray tracing with a focus on ParaView w/ OSPRay at TACC
 +
* [[howtos|Howtos]]
 +
: These howtos are instructions for some common operations.
 +
* [[Related Publications]]
 +
: ParaView related books, articles, and papers
 +
* [[ParaView 3 Tutorials]]
 +
* [[ParaView 2 Tutorials]]
 +
 
 +
 
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 
 +
===Design & Implementation===
 +
----
 +
* [[Testing design]]
 +
: ParaView GUI Testing framework.
 +
* [[Block Hierarchy Meta Data]]
 +
: Providing details about blocks, hierarchies, assemblies etc. to the client.
 +
* [[Multiple views]]
 +
: Details on handling multiple views in client-server framework.
 +
* [[Composite Datasets in VTK|Composite Datasets]]
 +
: Dealing with composite datasets in VTK.
 +
* [[Representations and Views]]
 +
: Understanding ParaView's views and representations.
 +
* [[Time in ParaView]]
 +
: Understanding Time implementation.
 +
* [[Cross compiling ParaView3 and VTK|Cross-compiling ParaView]]
 +
: Compiling ParaView and VTK on BlueGene and Cray Xt3/Catamount.
 
* [[Selection Implementation in VTK and ParaView III]]
 
* [[Selection Implementation in VTK and ParaView III]]
 +
* [[Suggested online help documentation changes]]
 +
: Suggestions for online help documentation changes.
 +
* [[ServerManager XML Hints]]
 +
: A place to document ServerManager configuration XML hints.
 +
 +
===ParaView based Applications===
 +
----
 +
* [[StreamingParaView]]
 +
: Documentation about the StreamingParaView application.
 +
* [[VeloView]]
 +
: An application for visualizing and processing Velodyne LiDAR data
 +
 +
===Web Visualization with ParaView===
 +
----
 +
* [[ParaViewWeb | ParaView Web Visualization Framework]]
 +
: Documentation for the ParaView Web Visualization Framework
 +
 +
===''In situ'' Analysis with ParaView===
 +
----
 +
* [[ParaView/Catalyst/Overview | ParaView Catalyst]]
 +
: Documentation for using ParaView for co-processing
 +
 +
===Plugins Distributed with ParaView===
 +
----
 +
:[[ParaView/Users_Guide/Included Plugins| Included Plugins]]
 +
 +
===Community Contributed Plugins===
 +
----
 +
:[[ParaView/Guidelines for Contributing Plugins | Guidelines for Contributing Plugins]]
 +
 +
===Miscellaneous===
 +
----
 +
* [https://blog.kitware.com/the-source-newsletter/ The Kitware Source]
 +
: A quarterly newsletter for developers designed to deliver detailed technical articles related to Kitware's open source products including ParaView.
 +
* [[Terminology map | Real world concept -> Paraview terminology map]]
 +
: Often new users may say "Surely Paraview can do X... but I can't find it!". This terminology map should help!
  
==Administrative Topics==
+
===Developers Corner===
 +
----
 +
====Discussion Forum====
 +
A forum for ParaView discussion, both its use and development, is available at https://discourse.paraview.org/.
  
* Where can I find more [[ParaView:Additional Information|information about ParaView]]?
+
====Plugin Development====
 +
* [[Paraview_Make building Paraview plugin optional|Make building Paraview plugin optional]]
  
* Where can I [http://www.paraview.org/HTML/Download.html download ParaView]?
+
====Handy Developer Info====
 +
* [[ParaView/Developer_Info | Developer Information]]
  
* [[ParaView III and Qt licensing]]
+
====Release Testing====
 +
* [[Release Testing]]
 +
* [[Remote Cluster Testing]]
  
 
{{ParaView/Template/Footer}}
 
{{ParaView/Template/Footer}}
 +
|}

Latest revision as of 16:36, 26 September 2018

link title

Pvsplash1.png


ParaView is an open-source, multi-platform application designed to visualize data sets of varying sizes from small to very large. The goals of the ParaView project include developing an open-source, multi-platform visualization application that supports distributed computational models to process large data sets. It has an open, flexible, and intuitive user interface. Furthermore, ParaView is built on an extensible architecture based on open standards. ParaView runs on distributed and shared memory parallel as well as single processor systems and has been successfully tested on Windows, Linux, Mac OS X, IBM Blue Gene, Cray XT3 and various Unix workstations and clusters. Under the hood, ParaView uses the Visualization Toolkit as the data processing and rendering engine and has a user interface written using the Qt cross-platform application framework.

The goal of this Wiki is to provide up-to-date documentation maintained by the developer and user communities. As such, we welcome volunteers that would like to contribute. If you are interested in contributing to ParaView or to this wiki, please post a message on the ParaView Discourse forum at https://discourse.paraview.org/.

For new users, download and install the ParaView binaries for your local computer, and then read The ParaView Tutorial. Additional tutorials are located under #Books and Tutorials below.

You can find more information about ParaView on the ParaView web site: http://paraview.org. For more help, including a list of all sources and filters, check out http://paraview.org/paraview/help/documentation.html.

ParaView In Use

Some examples of how ParaView is used
Screenshots generated by ParaView
Links to documentation of ParaView installations on various HPC sites

Documentation

License

Compile/Install


Instructions for downloading source as well as pre-compiled binaries for common platforms.
Collection of release notes for official ParaView releases.
Git is the revision control system that ParaView uses. If you would like to have the bleeding edge version of ParaView, or you would like to contribute code, this link describes the method you must use to get the code.
Downloading nightly binaries for development versions of ParaView.
Compiling and installing ParaView from source.
Building ParaView with Mesa 3D.
Information about the official ParaView builds and versions of various dependencies used.
Information on cross compiling ParaView and VTK for Xeon Phi KNC

Server Setup


Configuring your cluster to act as a ParaView server.
Using the ParaView client to start the servers.
Customizing server startup and connection processes using XML-based configuration scripts.
Strategies for distributing server configuration xmls.
To run ParaView on clusters with head nodes - compute nodes
Configure your cluster environment such as DISPLAY, or Cave settings using *.pvx xml files.
A guide for configuring a cluster to run ParaView

Importing Data


How to write out data in a format that Paraview understands
More information on data formats ParaView supports and how to load them.
How to write a VTK reader that will read your data directly into ParaView.
How data is loaded in parallel for various readers.

Finding Data


Selecting and focusing on subset of a dataset using queries.
Selecting and focusing on subset of a dataset.

Analyzing Data


Creating visualizations to compare effects for change in parameter(s).
Computing statistics and using them to assess datasets.

Animation


Animating file series.
Saving animations on the server without client connection.
Using Animation View to setup animations.
Creating animations involving camera movements.

Plugins


Using and writing new plugins to extend ParaView's functionality.
Including extensions into ParaView at compile time.
A simple wizard application developed by MIRARCO that provides boilerplate code for some of the most common plugin types.
Please post plugins that you have created that may be useful for other users.
Writing custom applications based on ParaView.
Building plugins for deployment with Released ParaView binaries.

Python Scripting


Environment variables to set when using a Python shell besides pvpython/pvbatch.
Scripting ParaView using python
Generating/Processing data using python.
Using the python shell interface in paraview including generating python trace.
Collection of python scripts for some common tasks.

GUI Features


Synchronizing filters, clip planes, camera etc.
Creating visualizations for Print and Screen.
Details of ParaView's xml colormap file format and collections of colormaps for use with ParaView.
Using ParaView Copy/Paste inside information tab and spreadsheet view
Packaging pipelines into a single composite.
How to configure ParaView's image compressor for use during remote rendering.
Using ParaView's Memory Inspector Panel and its debugging features.
The locations where ParaView saves settings files (also known as config or configuration files).
Using and customizing the Properties Panel.
Using ParaView with Space Navigator
What can be done with the spreadsheet column sorting and how it works
Searching in long lists and tables in the ParaView GUI.
Design document

Other Features


Loading restarted data for different file formats.
Exporting scenes as VRML, X3D etc.
Backwards compatibility for ParaView state files (*.pvsm).
Information of the changes that have been done undercover to support and improve collaboration.
Export publication quality 3D scenes and charts.
Annotating scenes with mathematical equations.
Documentation describing how to configure and use the surface LIC plugin.

Books and Tutorials


The official ParaView guide available from Kitware. Book Errata
You can download the open-source PDF edition from the downloads page.
API documentation auto-generated from the source files.
An introductory and comprehensive tutorial.
The official ParaView Catalyst User's Guide v2.0 corresponding to ParaView 4.3.1.
Beginning and advanced tutorial sets, each presented as 3-hour classes by Sandia National Laboratories
Short course on ray tracing with a focus on ParaView w/ OSPRay at TACC
These howtos are instructions for some common operations.
ParaView related books, articles, and papers


Design & Implementation


ParaView GUI Testing framework.
Providing details about blocks, hierarchies, assemblies etc. to the client.
Details on handling multiple views in client-server framework.
Dealing with composite datasets in VTK.
Understanding ParaView's views and representations.
Understanding Time implementation.
Compiling ParaView and VTK on BlueGene and Cray Xt3/Catamount.
Suggestions for online help documentation changes.
A place to document ServerManager configuration XML hints.

ParaView based Applications


Documentation about the StreamingParaView application.
An application for visualizing and processing Velodyne LiDAR data

Web Visualization with ParaView


Documentation for the ParaView Web Visualization Framework

In situ Analysis with ParaView


Documentation for using ParaView for co-processing

Plugins Distributed with ParaView


Included Plugins

Community Contributed Plugins


Guidelines for Contributing Plugins

Miscellaneous


A quarterly newsletter for developers designed to deliver detailed technical articles related to Kitware's open source products including ParaView.
Often new users may say "Surely Paraview can do X... but I can't find it!". This terminology map should help!

Developers Corner


Discussion Forum

A forum for ParaView discussion, both its use and development, is available at https://discourse.paraview.org/.

Plugin Development

Handy Developer Info

Release Testing



ParaView: [Welcome | Site Map]