The Viskores User’s Guide

The Viskores User’s Guide

Release 1.1.1

Kenneth Moreland

with special contributions from Vicente Bolea, Hank Childs, Nickolas Davis, Mark Kim, James Kress, Matthew Letter, Li-Ta Lo, Robert Maynard, Sujin Philip, David Pugmire, Nick Thompson, Allison Vacanti, Abhishek Yenpure, and the Viskores community.

Moreland, K. (2025). The Viskores User’s Guide, Release 1.1, Tech report ORNL/TM-2025/4175, Oak Ridge National Laboratory.

Join the Viskores Community at https://github.com/Viskores/viskores.

Viskores User's Guide

• 1. Getting Started
  • 1.1. Introduction
  • 1.2. Building and Installing Viskores
  • 1.3. Quick Start
• 2. Using Viskores
  • 2.1. Base Types
  • 2.2. Viskores Version
  • 2.3. Initialization
  • 2.4. Data Sets
  • 2.5. File I/O
  • 2.6. Running Filters
  • 2.7. Provided Filters
  • 2.8. Rendering
  • 2.9. Error Handling
  • 2.10. Managing Devices
  • 2.11. Timers
  • 2.12. Implicit Functions
• 3. Developing Algorithms
  • 3.1. General Approach
  • 3.2. Basic Array Handles
  • 3.3. Simple Worklets
  • 3.4. Basic Filter Implementation
  • 3.5. Unknown Array Handles
• 4. Advanced Development
  • 4.1. Advanced Types
  • 4.2. Logging
  • 4.3. Worklet Types
  • 4.4. Extended Filter Implementations
  • 4.5. Worklet Error Handling
  • 4.6. Math
  • 4.7. Working with Cells
  • 4.8. Memory Layout of Array Handles
  • 4.9. Fancy Array Handles
  • 4.10. Global Arrays and Topology
  • 4.11. Execution Objects
  • 4.12. Locators
  • 4.13. Worklet Input Output Semantics
• 5. Core Development
• 6. Appendix
  • 6.1. Acknowledgements
  • 6.2. License
  • Index