ParaView/Superbuild: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Replaced content with "Updated for ParaView Superbuild have moved to the [https://gitlab.kitware.com/paraview/paraview-superbuild/ source repository] starting with ParaView 5.2. For docs for ear...")
 
(54 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<font color="green">'''THIS PAGE IS UNDER CONSTRUCTION FOR THE UPCOMING PARAVIEW RELEASE. PLEASE CHECKBACK LATER'''</font>
Updated for ParaView Superbuild have moved to the [https://gitlab.kitware.com/paraview/paraview-superbuild/ source repository] starting with ParaView 5.2. For docs for earlier versions, please check out the history tab for this page.
 
=Introduction=
 
This page describes how to build ParaView binaries along with most, if not all, of the external dependencies that ParaView needs to generate a full featured build of ParaView.
 
We use [http://www.kitware.com/media/html/BuildingExternalProjectsWithCMake2.8.html CMake External Projects] to provide users/developers with a uber cmake project that can build ParaView and its dependencies and hence we refer to it as the ''ParaView Superbuild''. For instructions on building ParaView itself, providing installed or prebuilt versions of the dependencies, refer to [[ParaView:Build And Install]] instructions.
 
The process described here can be used to generate redistributable binaries and is indeed the process we use to generate binaries available for download from [http://paraview.org ParaView] download page. Although, the user can control some of the feature set, advanced capabilities are not exposed requiring users to dig into the cmake files to change esoteric configuration parameters. We summarize the structure of the cmake files at the end of this document. These can be easily customized to adapt for building extra dependencies or plugins or custom applications.
 
=Prerequisites=
* ParaView-Superbuild requires [http://cmake.org CMake], version 2.8.8 or higher and a working compiler.  On Unix-like operating systems, it also requires Make, while on Windows it requires Visual Studio (8 or later). Follow these [[ParaView:Build_And_Install#Download_And_Install_CMake|instructions]] to download and install cmake. This document assumes familiarity with using CMake.
 
* On Windows, in order to enable scripting support, [http://python.org Python] is required.
 
=Obtaining the source=
 
ParaView-Superbuild is available as separate Git repository. Simply clone the ParaViewSuperbuild.git repo. One may browse the repositories online using the [http://git.wiki.kernel.org/index.php/Gitweb Gitweb] interface at http://paraview.org/gitweb.
 
{|border="1" cellspacing="0" cellpadding="3"
!Repository
!Purpose
!Access
!URL
|-
|rowspan=3|<code>ParaViewSuperbuild.git</code>
|rowspan=3|ParaView Super-Build
|fetch (git)
|<code>git://paraview.org/ParaViewSuperbuild.git</code>
|-
|fetch (http)
|<code>http://paraview.org/ParaViewSuperbuild.git</code>
|-
|push (ssh)
|<code>git@paraview.org:ParaViewSuperbuild.git</code>
|}
 
 
=Developer Notes=
 
This section describes the under-pinnings of the cmake files that build ParaView and its dependencies.
 
 
==Overview==
 
ParaView Super-Build is used to build and package multiple projects. The general strategy is that we build sub-projects, including ParaView, and install the sub-project using its install rules under a specific root directory. By passing CMAKE_PREFIX_PATH to point to this root, we rely on sub-projects finding each other as needed. Once all sub-projects are built and installed in this internal root directory, we run a cmake script that generates the redistributable package. This script tends to be highly customized for the platform and the application since it is expected to leverage all the knowledge about files that need to go into the package and where should they be placed.

Latest revision as of 15:01, 15 October 2016

Updated for ParaView Superbuild have moved to the source repository starting with ParaView 5.2. For docs for earlier versions, please check out the history tab for this page.