ParaView:Build And Install: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
 
(196 intermediate revisions by 26 users not shown)
Line 1: Line 1:
=Introduction=
=Introduction=


This page describes how to build and install ParaView. It covers both the release and the development version. Also, it covers both Unix type systems (Linux, HP-UX, Solaris), as well as Windows.
'''<font color="red">This page has been replaced by [https://gitlab.kitware.com/paraview/paraview/blob/master/Documentation/dev/build.md build documentation in the paraview repository].


=Pre-requisites=
'''To build ParaView complete with all the dependencies it needs and to package it, use the [https://gitlab.kitware.com/paraview/paraview-superbuild/-/blob/master/README.md?ref_type=heads paraview superbuild instructions].</font>


ParaView build process requires [http://www.cmake.org CMake] version 2.0.6 or higher and 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.
{{ParaView/Template/Footer}}
 
==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 the CMake does not exist on the system, and there are no pre-compiled binaries, use instruction on how to build it.
 
===Use Binaries===
 
There are several precompiled binaries available at [http://www.cmake.org/HTML/Download.html CMake download page].
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
Let say on Linux, download the appropriate version and follow these instructions:
 
* Download http://www.cmake.org/files/v2.0/cmake-2.0.6-x86-linux.tar.gz
 
<pre>
cd $HOME
wget http://www.cmake.org/files/v2.0/cmake-2.0.6-x86-linux.tar.gz
mkdir software
cd software
tar xvfz ../cmake-2.0.6-x86-linux.tar.gz
ls
tar xvf cmake-2.0.6-x86-linux-files.tar
</pre>
 
* Now you have directory '''$HOME/software/bin''' and inside there are executables '''cmake''' and '''ccmake'''.
* You can also install CMake in the '''/usr/local''' or '''/opt''' by untaring into different directory. The rest of instructions will assume it is in '''$HOME/software/bin'''.
 
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
====On Windows====
* Download installer http://www.cmake.org/files/v2.0/CMSetup206.exe
* Follow instllation instructions
 
====On Windows if you are not administrator====
* Download http://www.cmake.org/files/v2.0/cmake-2.0.6-x86-win.zip
* Uncompress into some directory
* Optional: create a shortcut on the desktop.
</div>
|}
 
===Build Your Own CMake===
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
====On Unix like operating system====
Download the source code http://www.cmake.org/files/v2.0/cmake-2.0.6.tar.gz
 
<pre>
cd $HOME
wget http://www.cmake.org/files/v2.0/cmake-2.0.6.tar.gz
tar xvfz cmake-2.0.6.tar.gz
mkdir cmake-2.0.6-bin
cd cmake-2.0.6-bin
../cmake-2.0.6/bootstrap --prefix=$HOME/software
make
make install
</pre>
 
* Again, you can install it in '''/usr/local''' or '''/opt''' by changing the prefix.
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
====On Windows====
To build CMake on windows, previous version of CMake is required. This can be downloaded from [http://www.cmake.org/HTML/Download.html CMake download page].
 
</div>
|}
 
=Build ParaView=
 
==Download ParaView Source Code==
 
If you are trying to build ParaView release, download it from the release page. For development version, please follow instructions for checking out from CVS.
 
===Download The Release===
 
You can always download the binaries from [http://www.paraview.org/HTML/Download.html ParaView download page]. This page contains binaries for several platforms and the source code for the releases.
 
===Checkout Development Version From CVS===
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
====On Unix like operating system====
<pre>
mkdir $HOME/projects
cd $HOME/projects
 
cvs -d:pserver:anoncvs@www.paraview.org:/cvsroot/ParaView login
<nowiki><enter></nowiki>
cvs -d:pserver:anoncvs@www.paraview.org:/cvsroot/ParaView co ParaView
</pre>
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
====On Windows====
If you have Cygwin or Mingw shell, then use them and follow instructions for Unix like oprating system.
If you are on Windows and do not have Cygwin or Mingw shell, please download CVS client. We recommend [http://www.tortoisecvs.org/ TortoiseCVS], which is a GUI for CVS on Windows.
 
</div>
|}
 
==Configure ParaView With CMake==
* Always use separate build directory. Do not build in the source directory
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
===On Unix like system===
* Use ccmake (Curses CMake GUI) from the CMake installed location.
 
<pre>
mkdir $HOME/projects/ParaView-bin
cd $HOME/projects/ParaView-bin
 
$HOME/software/bin/ccmake $HOME/projects/ParaView
</pre>
[[Image:Brpv ccmake.png|400px]]
===About CCMake (Curses CMake GUI)===
 
* Iterative process
** Select values, run configure (c key)
** Set the settings, run configure, set the settings run configure etc.
* Repeat until all values are set and generate option is available (g key)
* Some variables (advanced variables) are not visible right away
* To see advanced varables, toggle to advanced mode (t key)
* To set variable, move cursor to the variable and press enter
** If it is a boolean (ON/OFF) it will flip the value
** If it is string or file, it will allow editing of the string
** For file and directories, <nowiki><tab></nowiki> key can be used to complete
* To search for the variable press '/' key and for repeat search, press 'n' key.
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
===On Windows===
* Use CMakeSetup from the CMake install location.
* Make sure to select the apropriate source and the build directory
* Also, make sure to pick the apropriate generator (on Visual Studio 6, pick ''Visual Studio 6'' generator).
[[Image:Brpv cmakesetup.png|400px]]
 
===About CMakeSetup (Windows CMake GUI)===
 
* Iterative process
** Select values, press Configure button
** Set the settings, run configure, set the settings run configure etc.
* Repeat until all values are set and Ok button becomes available.
* Some variables (advanced variables) are not visible right away
* To see advanced varables, toggle to advanced mode ("Show Advanced Values" toggle).
* To set value of a variable, click on that value.
** If it is boolean (ON/OFF), it will change the value.
** If it is file or directory, an ellipsis button appears ("...") on the far right of the entry. Clicking this button brings up the file or directory selection dialog.
** If it is a string, it will become editable string.
</div>
|}
 
===ParaView Settings===
 
{| border="0" cellpadding="4" cellspacing="4"
|-
| bgcolor="#abcdef" height="8" |  '''Variable'''
| bgcolor="#abcdef" height="8" |  '''Description'''
|-
| 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 availabel 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. It is ok for this one to be set to MPI_EXTRA_LIBRARY-NOTFOUND.
|-
| MPI_INCLUDE_PATH || Path to MPI includes (such as /usr/include/mpi). Again, should be found by default.
|-
|}
 
===Finish Configuring ParaView===
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
====Using CCMake====
 
* Once all configuration options are set, you should be able to just run <nowiki><generate></nowiki> (g key).
 
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
====Using CMakeSetup====
* Once all configuration options are set, you should be able to just run <nowiki><generate></nowiki>, by clicking "OK" button.
</div>
|}
 
==Build ParaView==
 
You can now build the ParaView using the apropriate build system.
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
===Using Make===
CMake will now generate Make files. These makefiles have all dependencies and all all rules to build ParaView on this system. You should not however try to move the build directory to another location or on another system.
 
Once you have makefiles you should be able to just type:
 
  make
 
* If you are on multi-processor system (let say 4 procesor), you can type:
 
  make -j 4
 
[[Image:Brpv make.png|400px]]
 
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
===Using Visual Studio===
CMake will now create Visual Studio project files.
You should now be able to open '''ParaView''' project file. Make sure to select apropriate build type (Debug, Release, ...).
To build ParaView, simply build the '''ALL_BUILD''' target.
 
[[Image:Brpv visualstudio71.png|400px]]
</div>
|}
 
=Install ParaView=
 
ParaView can be run directly from the build directory. That said, for production environments, it should be installed on some system location.
 
{| cellspacing="3"
|- valign="top"
|width="50%" class="MainPageBG" style="border: 1px solid #ffc9c9; color: #000; background-color: #fff3f3"|
<div style="padding: .4em .9em .9em">
====Using Make====
 
On Unix like operating systems it 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:
 
<pre>
  su
  <root password>
  make install
</pre>
 
</div>
|width="50%" class="MainPageBG" style="border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff"|
<div style="clear: right; text-align: left; float: right; padding: .4em .9em .9em">
====Using Visual Studio====
On Windows, this locations is something like ''c:\Program Files\ParaView''.
 
To install ParaView, simply run ''INSTALL'' target within the build system.
</div>
|}

Latest revision as of 23:43, 19 March 2024

Introduction

This page has been replaced by build documentation in the paraview repository.

To build ParaView complete with all the dependencies it needs and to package it, use the paraview superbuild instructions.




ParaView: [Welcome | Site Map]