Viskores is a toolkit of scientific visualization algorithms for emerging processor architectures. Viskores supports the fine-grained concurrency for data analysis and visualization algorithms required to drive extreme scale computing by providing abstract models for data and execution that can be applied to a variety of algorithms across many different processor architectures.
Current Status
Viskores is a adopting the functionality of Viskores as a part of the [High Performance Software Foundation] (HPSF). As this project becomes more functional, more details will be added here.
Technical Charter
See the technical charter and governance document for the structure of the project.
Learning Resources
- A high-level overview is given in the IEEE Vis talk "[Viskores: Accelerating the Visualization Toolkit for Massively Threaded Architectures]Viskores Overview."
- The Viskores Users Guide provides extensive documentation. It is broken into multiple parts for learning and references at multiple different levels.
- "Part 1: Getting Started" provides the introductory instruction for building Viskores and using its high-level features.
- "Part 2: Using Viskores" covers the core fundamental components of Viskores including data model, worklets, and filters.
- "Part 3: Developing with Viskores" covers how to develop new worklets and filters.
- "Part 4: Advanced Development" covers topics such as new worklet types and custom device adapters.
- A practical Viskores Tutorial based in what users want to accomplish with Viskores:
- Building Viskores and using existing Viskores data structures and filters.
- Algorithm development with Viskores.
- Writing new Viskores filters.
- Community discussion takes place on the Viskores users discussion.
- Doxygen-generated reference documentation is available for the tip of the release branch at Viskores Doxygen latest
Contributing
There are many ways to contribute to Viskores, with varying levels of effort.
See the CONTRIBUTING.md for more ways to contribute and instructions.
Dependencies
Viskores Requires:
- C++14 Compiler. Viskores has been confirmed to work with the following
- GCC 5.4+
- Clang 5.0+
- XCode 5.0+
- MSVC 2015+
- Intel 17.0.4+
- CMake
- CMake 3.15+
- CMake 3.24+ (for ROCM+THRUST support)
Optional dependencies are:
- Kokkos Device Adapter
- Kokkos 3.7+
- CXX env variable or CMAKE_CXX_COMPILER should be set to hipcc when using Kokkos device adapter with HIP (ROCM>=6).
- CUDA Device Adapter
- TBB Device Adapter
- OpenMP Device Adapter
- Requires a compiler that supports OpenMP >= 4.0.
- OpenGL Rendering
- The rendering module contains multiple rendering implementations including standalone rendering code. The rendering module also includes (optionally built) OpenGL rendering classes.
- The OpenGL rendering classes require that you have a extension binding library and one rendering library. A windowing library is not needed except for some optional tests.
- Extension Binding
- On Screen Rendering
- OpenGL Driver
- Mesa Driver
- On Screen Rendering Tests
- Headless Rendering
Viskores has been tested on the following configurations:
- On Linux
- GCC 5.4.0, 5.4, 6.5, 7.4, 8.2, 9.2; Clang 5, 8; Intel 17.0.4; 19.0.0
- CMake 3.12, 3.13, 3.16, 3.17
- CUDA 9.2, 10.2, 11.0, 11.1
- TBB 4.4 U2, 2017 U7
- On Windows
- Visual Studio 2022
- CMake 3.12, 3.17
- CUDA 10.2
- TBB 2017 U3, 2018 U2
- On MacOS
- AppleClang 9.1
- CMake 3.12
- TBB 2018
Building
Viskores supports all major platforms (Windows, Linux, OSX), and uses CMake to generate all the build rules for the project. The Viskores source code is available from the Viskores download page or by directly cloning the [Viskores git repository].
The basic procedure for building Viskores is to unpack the source, create a build directory, run CMake in that build directory (pointing to the source) and then build. Here are some example *nix commands for the process (individual commands may vary).
$ tar xvzf ~/Downloads/viskores-v2.0.0.tar.gz
$ mkdir viskores-build
$ cd viskores-build
$ cmake-gui ../viskores-v2.0.0
$ cmake --build -j . # Runs make (or other build program)
A more detailed description of building Viskores is available in the [Viskores Users Guide].
Example
The Viskores source distribution includes a number of examples. The goal of the Viskores examples is to illustrate specific Viskores concepts in a consistent and simple format. However, these examples cover only a small portion of the capabilities of Viskores.
Below is a simple example of using Viskores to create a simple data set and use Viskores's rendering engine to render an image and write that image to a file. It then computes an isosurface on the input data set and renders this output data set in a separate image file:
int main(int argc, char* argv[])
{
std::string fieldName = "tangle";
tangleData.GetCoordinateSystem(),
tangleData.GetField(fieldName),
colorTable);
CanvasRayTracer canvas(2048, 2048);
view.Paint();
view.SaveAs("volume.png");
isoActor.SetScalarRange(actor.GetScalarRange());
isoView.Paint();
isoView.SaveAs("isosurface_wireframer.png");
solidView.Paint();
solidView.SaveAs("isosurface_raytracer.png");
return 0;
}
A minimal CMakeLists.txt such as the following one can be used to build this example.
cmake_minimum_required(VERSION 3.12...3.15 FATAL_ERROR)
project(ViskoresDemo CXX)
#Find the Viskores package
find_package(Viskores REQUIRED QUIET)
if(TARGET viskores::rendering)
add_executable(Demo Demo.cxx)
target_link_libraries(Demo PRIVATE viskores::filter viskores::rendering viskores::source)
endif()
License
Viskores is distributed under the OSI-approved BSD 3-clause License. See LICENSE.txt for details.
