|
|
| Line 1: |
Line 1: |
| ==Prerequisites==
| |
|
| |
|
| *Python is required for generation of the source tree and the wrapping code [http://www.python.org].
| |
| *The Catalyst build process requires [http://www.cmake.org CMake] version 2.8.8 or higher, a working compiler and make.
| |
| *MPI [http://www-unix.mcs.anl.gov/mpi/], [http://www.lam-mpi.org/] is also required.
| |
| *If the source tree is to be generated manually then a clone of the ParaView git repository is needed. See [http://paraview.org/Wiki/index.php?title=ParaView:Build_And_Install&action=submit#Checkout_Development_Version_from_git Checkout Development Version from git] on the ParaView Wiki.
| |
|
| |
| == Generating Catalyst Source Tree ==
| |
| A tarball of the Catalyst source can be downloaded from the [http://catalyst.kitware.com/replace_with_link Catalyst Website]. However, the Catalyst source tree can also be generated manually from a ParaView source tree. The Catalyst source tree is generated using a Python script located in the ParaView source tree ([http://http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Catayst/catalyze.py Catalyst/catalyze.py]). The script takes a JSON manifest file (manifest.json) that describes what files are copied and transformed from ParaView to produce the Catalyst source tree. For example the following segment of JSON indicates that the VTK module vtkCommonMath should be included (excluding the Testing directory) and it should be Python wrapped:
| |
|
| |
| <source lang="javascript">
| |
|
| |
| {
| |
| "name":"vtkCommonMath",
| |
| "path":"VTK/Common/Math",
| |
| "exclude":[
| |
| {
| |
| "path":"Testing"
| |
| }
| |
| ],
| |
| "pythonwrap":true
| |
| }
| |
|
| |
| </source>
| |
| The full manifest for the "Base" edition can be found here ([http://http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Catalyst/Editions/Base/manifest.json Catalyst/Editions/Base/manifest.json]) in the ParaView source tree.
| |
|
| |
| To generate the source tree for the "Base" Catalyst edition. The following commands should be run:
| |
|
| |
| <pre>
| |
| cd <paraview_repo>/Catalyst
| |
| python catalyze.py -i Editions/Base/ -o <catalyst_source_dir>
| |
| </pre>
| |
|
| |
| Where <paraview_repo> is the root directory of the ParaView source tree and <catalyst_source_dir> is the target output directory. The target output directory should be outside of the ParaView source tree. The produced source tree can then be built using the steps described in [[#Build Directions|Build Directions]]
| |
|
| |
| == Build Directions ==
| |
| A tarball of the Catalyst source can be downloaded from the [http://catalyst.kitware.com/replace_link Catalyst Website] or a source tree can be generated from a ParaView source tree using the steps describe in [[#Generating Catalyst Source Tree|Generating Catalyst Source Tree]].
| |
| The Catalyst source tree contains a shell script called cmake.sh that provides the appropriate cmake command to configure Catalyst. To configure Catalyst the following command should be run:
| |
|
| |
| <pre>
| |
| cd <catalyst_build_dir>
| |
| <catalyst_source_dir>/cmake.sh <catalyst_source_dir>
| |
| </pre>
| |
|
| |
| Where <catalyst_build_dir> is the target build directory for Catalyst and <catalyst_source_dir> is the source tree. Note other CMake options can be passed to the script, for example a generator could be specified using the -G option.
| |
|
| |
| Once the cmake.sh script has been run, Catalyst can be built by running the following command (assuming the default generator is used):
| |
|
| |
| <pre>
| |
| cd <catalyst_build_dir>
| |
| make
| |
| </pre>
| |
| Where <catalyst_build_dir> is the target build directory for Catalyst.
| |
