Skip to content

Necessary extensions for pystencils v2.0 documentation

This Issue is gathers ideas and missing content for the documentation of the new pystencils version v2.0. This is it meant as a dynamic document that is growing by time during the development of pystenicls. Some subparts of this issue will be resolved step by step as separate, MR.

Possible Structure for Reference Guides

  • Symbolic Language
    • Symbols
    • Fields
    • SymPy Expressions
    • Assignments
    • Working with Integers
    • Vectors, Matrices and Arrays
    • The Type System
      • Type Casts & Mixed-Precision Computing
    • Simplifications and Transformations
  • Code Generation
    • Using the Code Generator
    • Configuration of the Code Generator
      • Targets
      • Data Types
      • Iteration Spaces
    • CPU Optimizations
      • OpenMP
      • Vectorization
      • Loop Transformations
    • GPU Kernels
  • Runtime System
    • Using pystencils interactively
      • Inspecting kernels
      • Debugging kernels
    • The DataHandling system
    • Plotting and Visualization
  • Integration
    • Integration with waLBerla and other frameworks -> refer to pystencils-sfg; explain about various caveats
    • GPU Kernels: note on memory management (pystencils takes only raw pointers!)
  • API Reference
    • Complete listings for all frontend APIs
Edited by Frederik Hennig