Difference between revisions of "Building VTK-m"

From VTKM
Jump to navigation Jump to search
(Created page with "VTK-m is an open source C++ header toolkit that provides the ability to do fine-grained concurrency on scientific visualization data structures. VTK-m has few required depende...")
 
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
VTK-m is an open source C++ header toolkit that provides the ability to do fine-grained concurrency on scientific visualization data structures. VTK-m has few required dependencies but supports several optional components.
+
Information about [https://gitlab.kitware.com/vtk/vtk-m/blob/master/README.md#dependencies dependencies] and [https://gitlab.kitware.com/vtk/vtk-m/blob/master/README.md#building building VTK-m] has moved to the [https://gitlab.kitware.com/vtk/vtk-m/blob/master/README.md#building VTK-m README]. More detailed information can be found in the [[Media:VTKmUsersGuide.pdf|VTK-m User's Guide]].
 
 
== Getting VTK-m ==
 
 
 
VTK-m is currently available from a kitware git repository, which has public anonymous read access. URLs that can be used to clone the git repository can be found on [http://public.kitware.com/vtkm.git the git project web page](http://public.kitware.com/vtkm.git).
 
 
 
If you haven't used git before, consider following [https://help.github.com/articles/set-up-git github's excellent setup guide]. To get a copy of the repository, issue a git clone command.
 
 
 
git clone http://public.kitware.com/vtkm.git
 
 
 
The repository supports access with the http, git, and ssh protocols. Push access is only allowed with the SSH protocol. If you want to contribute to Dax please read the [[Contributing to VTK-m]] page. If you are a core developer of Dax please use [https://www.kitware.com/Admin/SendPassword.cgi this link] to send your public SSH key to Kitware.
 
 
 
== Dependencies ==
 
 
 
* CMake: VTK-m uses CMake to configure the build. You will need a relatively new version of CMake. CMake 2.8.10 or newer is recommended.
 
* Boost: VTK-m requires the header version of Boost 1.48.0 or better. You do not need to install the Boost libraries.
 
 
 
== Supported Operating Systems and Compilers ==
 
 
 
VTK-m is supported on Windows, Mac OSX, and Linux and should work on other varieties of Unix. It is possible to compile VTK-m with many different compiler versions including GNU, CLANG, MSVC, Intel, and PGI.
 
 
 
== Building VTK-m with CMake ==
 
 
 
Although VTK-m is header only, the code needs to be configured for the local system. VTK-m also has a large testing framework that will ensure it is working correctly on your system.
 
 
 
Always configure VTK-m so that the build tree is not the same as the source directory. The project will not run in if the source and build directories are the same.
 
 
 
The basic steps to setting up VTK-m are as follows:
 
 
 
git clone http://public.kitware.com/vtkm.git
 
mkdir vtkm-build
 
cd vtkm-build
 
cmake-gui ../vtkm
 
make
 
make test
 
 
 
(Note that parallel makes are supported, so you can run something like <tt>make -j4</tt> to take advantage of multiple cores during the build.)
 

Latest revision as of 16:27, 17 July 2019

Information about dependencies and building VTK-m has moved to the VTK-m README. More detailed information can be found in the VTK-m User's Guide.