ParaView Complete README

Welcome To ParaView


Copyright Notice
Copyright (c) 2000-2001 Kitware Inc. 469 Clifton Corporate Parkway,
Clifton Park, NY, 12065, USA.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * Neither the name of Kitware nor the names of any contributors may be used
   to endorse or promote products derived from this software without specific 
   prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Introduction

Welcome to ParaView, an open-source, multi-platform, parallel scientific visualization application. Although it can be run on a single processor, ParaView is specifically designed to run on distributed parallel computers. ParaView has been succesfully tested on Windows and Linux workstations, clusters and SGI Origin 2000 systems. ParaView is a turnkey application written using the Visualization Toolkit and it has a framework based on a unique blend of Tcl/Tk and C++.

ParaView is an extensible, open-source visualization system designed for parallel computing environments. It is built on the open-source VTK software. It uses data streaming to process large datasets, supports parallel implementations of common algorithms, and uses parallel tree-composite rendering for a completely parallel solution.

The Origins of ParaView
ParaView is being developed as part of a three-year contract awarded to Kitware, Inc. by a consortium of three National Labs: Los Alamos, Sandia, and Livermore. The goal of the project is to develop scalable parallel processing tools with an emphasis on distributed memory implementations. The project includes parallel algorithms, infrastructure, I/O, support, and display devices. In addition, the turn-key application, ParaView, is being developed as part of this contract. One significant feature of the contract is that all software developed is to be delivered open source. Hence ParaView is available as an open-source system.

Features
The following summarizes the important features of ParaView:

Software Architecture

Visualization Capabilities

Parallel Processing

Compiling ParaView Complete

This distribution of ParaView contains ParaView, VTK and Tcl/Tk 8.2.3. You do not have to download VTK or Tcl/Tk separately to compile. However, if you want to use your own VTK, you should not use this distribution. Instead, use the ParaView distribution which does not contain VTK.

Install CMake
To use ParaView, you will have to download and install CMake which is a build configuration utility.

CMake can be obtained from http://public.kitware.com/CMake. See CMake documentation for installation instructions.

Next, build ParaView differently depending on the operating system:

Run CMake and Compile
Once CMake is installed, you are ready to build VTK and ParaView. We highly recommend reading the CMake documentation if you are not familiar with CMake: http://public.kitware.com/CMake/HTML/Documentation.html. (You can skip the Developer's Guide if you are not going to work with CMakeLists files.) In summary, ParaView Complete build consists of:

  1. Running one of the CMake user interfaces
  2. Changing configuration options
  3. Compiling (make on Unix, Visual Studio on Windows)
On Windows, you should use the CMakeSetup.exe application to setup the VTK and ParaView build. On Unix/Linux, you should use the CMake wizard (cmake -i) or the terminal interface (ccmake). See the CMake documentation for details.

ParaView Complete is designed such that all the default build options selected by CMake for VTK and ParaView are appropriate for building ParaView. However you might have to tell CMake the location of some include files and libraries (for example MPI libraries if you enabled MPI support).

Unix Installation

The following instructions only apply to UNIX systems. First we will give you the quick and dirty way to build ParaView Complete:

  1) untar the ParaView Complete distribution
  2) cd ParaViewComplete
  4) cmake -i (run cmake in wizard mode, where you have to answer questions about the build)
or
  4) ccmake (run the terminal based interface to cmake where you interactively change build options)
  5) if necessary change build options
  6) make
It is a very good idea to tell cmake what C and C++ compilers you will be using. This can avoid many build problems. On most systems you can pass this information to configure in the following way:
env CXX=/your/C++/compiler CC=/your/c/compiler cmake
otherwise you must set CXX and CC in your environment and then run ccmake (or cmake -i).

If you are planning to build ParaView for multiple architectures then you can either make a copy of the entire ParaView tree for each architecture and then follow the instructions above. Or you can have one copy of the ParaView tree and compile it in a different manner (out-of-source). Instead of running cmake from the ParaViewComplete directory, create a new directory where you have some free disk space (not in the ParaViewComplete tree), a possible name would be paraview-solaris. cd into this directory and then run cmake similar to the following example:

  ls /home/joe_user
      ParaViewComplete paraview-solaris paraview-sgi

  cd paraview-solaris
  ccmake /home/joe_user/ParaViewComplete
  or
  cmake -i /home/joe_user/ParaViewComplete
This will create makefiles in the paraview-solaris directory. Then you can run make in paraview-solaris to compile ParaView Complete. Repeat this process for each architecture you wish to build.

Windows Installation

The Windows build process uses the CMake GUI CMakeSetup. Then you use the compiler make utility to compile as follows.

  1) Install ParaView Complete distribution by unzipping into the appropriate
     directory.

  2) Execute CMakeSetup. This will pop-up a little
     GUI that allows you to tailor the build. It then starts
     building .dsw and .dsp files for Microsoft, or makefiles for Borland.
     You'll have to tell CMakeSetup where you've placed your ParaViewComplete
     source code, and where to build the object code and dll's (we'll call it
     "paraviewbin").

  3) When CMakeSetup completes, start up msdev and load ParaViewComplete.dsw.
     Select ALL_BUILD project, and build it.

We recommend a 300MByte minimum swap size or you might have trouble during the link phase.

Execution

For information about how to start and use ParaView, see the online documentation.