ParaView:Build And Install: Difference between revisions
m (→Notes) |
DaveDemarle (talk | contribs) (Updated page to reflect build process for ParaViewIII) |
||
Line 1: | Line 1: | ||
=Introduction= | =Introduction= | ||
This page describes how to build and install ParaView. It covers both the release and the development versions. Also, it covers both Unix-type systems (Linux, HP-UX, Solaris) as well as Windows. | This page describes how to build and install ParaView. It covers both the release and the development versions. Also, it covers both Unix-type systems (Linux, HP-UX, Solaris, Mac) as well as Windows. | ||
=Prerequisites= | =Prerequisites= | ||
The ParaView build process requires [http://www.cmake.org CMake] version 2. | The ParaView build process requires [http://www.cmake.org CMake] version 2.4.5 or higher and a working compiler. On Unix-like operating systems, it also requires Make, while on Windows it requires Visual Studio (6, 7, or 7.1). | ||
In order to run ParaView in parallel, MPI [http://www-unix.mcs.anl.gov/mpi/], [http://www.lam-mpi.org/] is also required. | Building ParaView's user interface requires Trolltech's Qt, version 4.2.2. Qt is dual licensed. To compile ParaView, either the open or commercial version may be used. If you intend to make changes the ParaView's GUI and distribute the results, you must obtain a commercial license. The open source version of Qt is here [http://trolltech.com/developer/downloads/qt/index]. Commercial licenses can be purchased directly from TrollTech [http://trolltech.com]. For more information on what can be done with the open source version, read this [http://www.itk.org/Wiki/ParaView_III_and_Qt_licensing]. | ||
In order to run ParaView in parallel, MPI [http://www-unix.mcs.anl.gov/mpi/], [http://www.lam-mpi.org/] is also required. | |||
In order to use scripting, python is required [http://www.python.org]. | |||
==Download And Install Cmake== | ==Download And Install Cmake== | ||
Line 24: | Line 28: | ||
Let's say on Linux, download the appropriate version and follow these instructions: | Let's say on Linux, download the appropriate version and follow these instructions: | ||
* Download http://www.cmake.org/files/v2.4/cmake-2.4. | * Download http://www.cmake.org/files/v2.4/cmake-2.4.5-Linux-i386.tar.gz | ||
<pre> | <pre> | ||
cd $HOME | cd $HOME | ||
wget http://www.cmake.org/files/v2.4/cmake-2.4. | wget http://www.cmake.org/files/v2.4/cmake-2.4.5-Linux-i386.tar.gz | ||
mkdir software | mkdir software | ||
cd software | cd software | ||
tar xvfz ../cmake-2.4. | tar xvfz ../cmake-2.4.5-Linux-i386.tar.gz | ||
</pre> | </pre> | ||
* Now you have the directory '''$HOME/software/cmake-2.4. | * Now you have the directory '''$HOME/software/cmake-2.4.5-Linux-i386/bin''', and inside there are executables '''cmake''' and '''ccmake'''. | ||
* You can also install CMake in the '''/usr/local''' or '''/opt''' by untaring and copying sub-directories. The rest of the instructions will assume the executables are in your '''$PATH'''. | * You can also install CMake in the '''/usr/local''' or '''/opt''' by untaring and copying sub-directories. The rest of the instructions will assume the executables are in your '''$PATH'''. | ||
Line 41: | Line 45: | ||
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em"> | <div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em"> | ||
====On Windows==== | ====On Windows==== | ||
* Download the installer http://www.cmake.org/files/v2.4/cmake-2.4. | * Download the installer http://www.cmake.org/files/v2.4/cmake-2.4.5-win32-x86.exe | ||
* Follow the installation instructions | * Follow the installation instructions | ||
====On Windows, if you are not administrator==== | ====On Windows, if you are not administrator==== | ||
* Download http://www.cmake.org/files/v2.4/cmake-2.4. | * Download http://www.cmake.org/files/v2.4/cmake-2.4.5-win32-x86.zip | ||
* Uncompress into some directory | * Uncompress into some directory | ||
* Optional: create a shortcut on the desktop. | * Optional: create a shortcut on the desktop. | ||
Line 58: | Line 62: | ||
<div style="padding: .4em .9em .9em"> | <div style="padding: .4em .9em .9em"> | ||
====On Unix-like operating systems==== | ====On Unix-like operating systems==== | ||
Download the source code http://www.cmake.org/files/v2. | Download the source code http://www.cmake.org/files/v2.4/cmake-2.4.5.tar.gz | ||
<pre> | <pre> | ||
cd $HOME | cd $HOME | ||
wget http://www.cmake.org/files/v2.4/cmake-2.4. | wget http://www.cmake.org/files/v2.4/cmake-2.4.5.tar.gz | ||
tar xvfz cmake-2.4. | tar xvfz cmake-2.4.5.tar.gz | ||
mkdir cmake-2.4. | mkdir cmake-2.4.5-bin | ||
cd cmake-2.4. | cd cmake-2.4.5-bin | ||
../cmake-2.4. | ../cmake-2.4.5/bootstrap --prefix=$HOME/software | ||
make | make | ||
make install | make install | ||
Line 178: | Line 182: | ||
| bgcolor="#abcdef" height="8" | '''Variable''' | | bgcolor="#abcdef" height="8" | '''Variable''' | ||
| bgcolor="#abcdef" height="8" | '''Description''' | | bgcolor="#abcdef" height="8" | '''Description''' | ||
|- | |||
| QT_QMAKE_EXECUTABLE || Path to Qt's qmake executable (such as /usr/local/Trolltech/Qt-4.2.2/bin/qmake). Cmake uses this to locate the rest of the required Qt executables, headers and libraries. | |||
|- | |- | ||
| BUILD_SHARED_LIBS || If ON, use shared libraries. This way executables are smaller, but you have to make sure the shared libraries are on every system on the cluster. | | BUILD_SHARED_LIBS || If ON, use shared libraries. This way executables are smaller, but you have to make sure the shared libraries are on every system on the cluster. | ||
Line 188: | Line 194: | ||
|- | |- | ||
| MPI_INCLUDE_PATH || Path to MPI includes (such as /usr/include/mpi). Again, this should be found by default. | | MPI_INCLUDE_PATH || Path to MPI includes (such as /usr/include/mpi). Again, this should be found by default. | ||
|- | |||
| PARAVIEW_ENABLE_PYTHON || Makes python client scripting and the python programmable filter available. | |||
|- | |||
| VTK_USE_CARBON || For Mac, this is the default. Neither X11 nor COCOA frameworks are supported. | |||
|- | |- | ||
|} | |} | ||
Line 279: | Line 289: | ||
== Notes == | == Notes == | ||
=== Compiling on the Mac === | === Compiling on the Mac === | ||
To compile on the Mac, follow the instructions for Unix | To compile on the Mac, follow the instructions for Unix. The recommended configuration settings are: | ||
{{ParaView/Template/Footer}} | {{ParaView/Template/Footer}} |
Revision as of 19:40, 3 October 2007
Introduction
This page describes how to build and install ParaView. It covers both the release and the development versions. Also, it covers both Unix-type systems (Linux, HP-UX, Solaris, Mac) as well as Windows.
Prerequisites
The ParaView build process requires CMake version 2.4.5 or higher and a working compiler. On Unix-like operating systems, it also requires Make, while on Windows it requires Visual Studio (6, 7, or 7.1).
Building ParaView's user interface requires Trolltech's Qt, version 4.2.2. Qt is dual licensed. To compile ParaView, either the open or commercial version may be used. If you intend to make changes the ParaView's GUI and distribute the results, you must obtain a commercial license. The open source version of Qt is here [1]. Commercial licenses can be purchased directly from TrollTech [2]. For more information on what can be done with the open source version, read this [3].
In order to run ParaView in parallel, MPI [4], [5] is also required.
In order to use scripting, python is required [6].
Download And Install Cmake
CMake is a tool that makes cross-platform building simple. On several systems it will probably be already installed. If it is not, please use the following instructions to install it. If CMake does not exist on the system, and there are no pre-compiled binaries, use the instructions below on how to build it.
Use Binaries
There are several precompiled binaries available at the CMake download page.
On Unix-like operating systemsLet's say on Linux, download the appropriate version and follow these instructions: cd $HOME wget http://www.cmake.org/files/v2.4/cmake-2.4.5-Linux-i386.tar.gz mkdir software cd software tar xvfz ../cmake-2.4.5-Linux-i386.tar.gz
|
On Windows
On Windows, if you are not administrator
|
Build Your Own CMake
On Unix-like operating systemsDownload the source code http://www.cmake.org/files/v2.4/cmake-2.4.5.tar.gz cd $HOME wget http://www.cmake.org/files/v2.4/cmake-2.4.5.tar.gz tar xvfz cmake-2.4.5.tar.gz mkdir cmake-2.4.5-bin cd cmake-2.4.5-bin ../cmake-2.4.5/bootstrap --prefix=$HOME/software make make install
|
On WindowsTo build CMake on windows, a previous version of CMake is required. This can be downloaded from the CMake download page. |
Build ParaView
Download ParaView Source Code
If you are trying to build a ParaView release, download it from the release page. For the development version, please follow the instructions below for checking it out from CVS.
Download The Release
You can always download the binaries from ParaView download page. This page contains binaries for several platforms and the source code for the releases.
Checkout Development Version from CVS
On Unix-like operating systemsmkdir $HOME/projects cd $HOME/projects cvs -d:pserver:anoncvs@www.paraview.org:/cvsroot/ParaView login <enter> cvs -d:pserver:anoncvs@www.paraview.org:/cvsroot/ParaView co ParaView |
On WindowsIf you have Cygwin or Mingw shell, then use them, and follow the instructions for Unix-like oprating systems. If you are on Windows and do not have Cygwin or Mingw shell, please download a CVS client. We recommend TortoiseCVS, which is a GUI for CVS on Windows. |
Configure ParaView With CMake
- Always use a separate build directory. Do not build in the source directory.
On Unix-like systems
mkdir $HOME/projects/ParaView-bin cd $HOME/projects/ParaView-bin ccmake $HOME/projects/ParaView About CCMake (Curses CMake GUI)
|
On Windows
About CMakeSetup (Windows CMake GUI)
|
ParaView Settings
Variable | Description |
QT_QMAKE_EXECUTABLE | Path to Qt's qmake executable (such as /usr/local/Trolltech/Qt-4.2.2/bin/qmake). Cmake uses this to locate the rest of the required Qt executables, headers and libraries. |
BUILD_SHARED_LIBS | If ON, use shared libraries. This way executables are smaller, but you have to make sure the shared libraries are on every system on the cluster. |
VTK_USE_MPI | Turn this to ON to enable MPI. Other MPI options will not be available until you turn this on. |
MPI_LIBRARY | Path to the MPI library (such as /usr/lib/libmpi.so). Should be found by default, but you may have to set it. |
MPI_EXTRA_LIBRARY | Path to extra MPI library (such as /usr/lib/libmpi++.so). If the MPI distribution is MPICH, this may not be found; in this case, it is ok for this variable to be set to MPI_EXTRA_LIBRARY-NOTFOUND. |
MPI_INCLUDE_PATH | Path to MPI includes (such as /usr/include/mpi). Again, this should be found by default. |
PARAVIEW_ENABLE_PYTHON | Makes python client scripting and the python programmable filter available. |
VTK_USE_CARBON | For Mac, this is the default. Neither X11 nor COCOA frameworks are supported. |
Finish Configuring ParaView
Using CCMake
|
Using CMakeSetup
|
Build ParaView
You can now build ParaView using the appropriate build system.
Using MakeCMake will now generate Make files. These makefiles have all dependencies and all rules to build ParaView on this system. You should not however try to move the build directory to another location on this system or to another system. Once you have makefiles you should be able to just type: make
make -j 4 |
Install ParaView
ParaView can be run directly from the build directory. That said, for production environments, it should be installed in some system location.
Using MakeOn Unix-like operating systems, the install location is /usr, /usr/local, /opt, or something similar. To install ParaView, simply run: make install Make sure to have write access to this location. If you do not, it may be necessary to run install as an administrator. For example, on Unix you would do something like: su <root password> make install |
Using Visual StudioOn Windows, this location is something like c:\Program Files\ParaView. To install ParaView, simply run INSTALL target within the build system. |
Notes
Compiling on the Mac
To compile on the Mac, follow the instructions for Unix. The recommended configuration settings are: