Difference between revisions of "Tutorial"

From VTKM
Jump to navigation Jump to search
m (Updating instructions to build VTK-m and examples for tutorial)
Line 19: Line 19:
 
In all, your process on Unix/Mac should be something like:
 
In all, your process on Unix/Mac should be something like:
 
<pre>
 
<pre>
# wget https://gitlab.kitware.com/vtk/vtk-m/-/archive/v1.4.0/vtk-m-v1.4.0.tar.gz
+
# wget https://gitlab.kitware.com/vtk/vtk-m/-/archive/v1.5.0/vtk-m-v1.5.0.tar.gz
# tar xvfz vtk-m-v1.4.0.tar.gz
+
# tar xvfz vtk-m-v1.5.0.tar.gz
# mkdir vtkm-build # out of source build
+
# mkdir vtkm-build vtkm-install # out of source build
 
# cd vtkm-build
 
# cd vtkm-build
# cmake ../vtk-m-v1.4.0
+
# cmake -DCMAKE_INSTALL_PREFIX=../vtkm-install -DVTKm_ENABLE_OPENMP:BOOL=ON -DVTKm_ENABLE_TESTING:BOOL=OFF ../vtk-m-v1.5.0
 
# cmake --build . -j 4
 
# cmake --build . -j 4
 
</pre>
 
</pre>
Line 42: Line 42:
 
<pre>
 
<pre>
 
# (downloads from above)
 
# (downloads from above)
# export P=/path/where/you/want/to/run/tutorial/examples
+
# export P=/path/where/you/want/to/place/tutorial/examples
 
# export D=/path/to/where/your/browser/downloads/files
 
# export D=/path/to/where/your/browser/downloads/files
# cp $D/kitchen.vtk $D/VTKm_tutorial_examples.tar $P
+
# cp $D/VTKm_tutorial_examples.tar $P
 
# cd $P
 
# cd $P
# tar xvf VTKm_tutorial_examples.tar # places 9 files in $PWD
+
# tar xvf VTKm_tutorial_examples.tar # places tutorial files in $PWD
# cmake . -DCMAKE_PREFIX_PATH="<path_to_vtkm-build>/"
+
# cmake . -DVTKm_DIR="<path_to_vtkm-installation>/"
 
# cmake --build .  
 
# cmake --build .  
 
# ./tut_io # run 1st example
 
# ./tut_io # run 1st example
 
# ls out_io.vtk # confirms 1st example successfully completed
 
# ls out_io.vtk # confirms 1st example successfully completed
 
</pre>
 
</pre>

Revision as of 17:11, 17 October 2019

WARNING: Under development!


About this page

This page contains materials for a VTK-m tutorial. A mini version of the tutorial will be offered at the VTK-m Code Sprint in Albuquerque on July 30th. The full version (3.5 hours) will be offered at VIS19 in Vancouver, Canada on Sunday October 20th.


Download and build VTK-m

Process:

  • Download V1.4.0 here.
    • (note the build page assumes you will be accessing the master via a git clone, but we encourage you to use the released version for the tutorial)
  • Do not enable the TBB, OpenMP or CUDA support, at least at first.
    • (we stand behind our support for these backends, but it is good to start simple)

In all, your process on Unix/Mac should be something like:

# wget https://gitlab.kitware.com/vtk/vtk-m/-/archive/v1.5.0/vtk-m-v1.5.0.tar.gz
# tar xvfz vtk-m-v1.5.0.tar.gz
# mkdir vtkm-build vtkm-install # out of source build
# cd vtkm-build
# cmake -DCMAKE_INSTALL_PREFIX=../vtkm-install -DVTKm_ENABLE_OPENMP:BOOL=ON -DVTKm_ENABLE_TESTING:BOOL=OFF ../vtk-m-v1.5.0
# cmake --build . -j 4

The main instructions to download and build are here. That said, we recommend following the instructions above.

Download tutorial materials

  1. [slides] (60+MB)
  2. [examples] (0.03MB)
  3. [kitchen.vtk data file] (2MB) (on Mac: right-click and "Save Link As")

Build example code

Your process on Unix/Mac should be something like:

# (downloads from above)
# export P=/path/where/you/want/to/place/tutorial/examples
# export D=/path/to/where/your/browser/downloads/files
# cp $D/VTKm_tutorial_examples.tar $P
# cd $P
# tar xvf VTKm_tutorial_examples.tar # places tutorial files in $PWD
# cmake . -DVTKm_DIR="<path_to_vtkm-installation>/"
# cmake --build . 
# ./tut_io # run 1st example
# ls out_io.vtk # confirms 1st example successfully completed