Difference between revisions of "Tutorial"

From VTKM
Jump to navigation Jump to search
(Updating VTK-m tutorial instructions)
Line 41: Line 41:
  
 
The main instructions to download and build are [https://gitlab.kitware.com/vtk/vtk-m/blob/master/README.md#building here].  That said, we recommend following the instructions above.
 
The main instructions to download and build are [https://gitlab.kitware.com/vtk/vtk-m/blob/master/README.md#building here].  That said, we recommend following the instructions above.
 +
 +
== Download Virtual Box image with VTK-m ==
 +
 +
The Virtual Box instance with VTK-m installed can be found [https://ix.cs.uoregon.edu/~ayenpure/VTKm-tutorial.ova here].
 +
VTK-m files can be accessed in the "/home/vtkm/Softwares/VTK-m/"
 +
# The `build` directory is where VTK-m is built usign `CMake`.
 +
# The `install` directory is where VTK-m is installed.
  
 
== Download tutorial materials ==
 
== Download tutorial materials ==

Revision as of 22:39, 17 October 2019

About this page

This page contains materials for the VTK-m tutorial.

This tutorial will be presented on Sunday October 20th at the VIS19 conference in Vancouver, Canada.

There are two options for running code:

  1. Building VTK-m on your own machine
  2. Running our VirtualBox image with VTK-m installed

Sections below describe how to pursue each of these options.

Additionally, attendees can get the slides HERE.

For additional development material, attendees can get the user guide HERE

This tutorial allows attendees to follow the tutorial by:

  1. Download and build VTK-m by themselves, or
  2. Use a Virtual Box image which has VTK-m built and installed

Download and build VTK-m

Process:

  • Download V1.5.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:

# (download VTK-m 1.5.0)
# tar xvfz vtk-m-v1.5.0.tar.gz
# mkdir build install # out of source build
# cd build
# cmake -DCMAKE_INSTALL_PREFIX=../install \
#       -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 Virtual Box image with VTK-m

The Virtual Box instance with VTK-m installed can be found here. VTK-m files can be accessed in the "/home/vtkm/Softwares/VTK-m/"

  1. The `build` directory is where VTK-m is built usign `CMake`.
  2. The `install` directory is where VTK-m is installed.

Download tutorial materials

  1. [examples] (0.03MB)

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 . -DCMAKE_PREFIX_PATH="<path_to_vtkm-installation>/"
# cmake --build . 
# ./tut_io # run 1st example
# ls out_io.vtk # confirms 1st example successfully completed