Dev doc

Welcome to the developer documentation of Shamrock.

Recommended order: set up the development environment, learn the solver graph (nodes and edges), then move on to GPU kernel programming (e.g. kernel call).

Contents

• IDE development setup
  • Repo setup
  • VSCode (and derivatives, e.g. Cursor, Vscodium, …)
  • Neovim (Lazyvim)
• Building the documentation
  • Repo setup
  • Building the Sphinx documentation
  • Building the doxygen doc
• History graphs
  • Doxygen warnings
  • Compile peak RSS (top 10 files)
  • Build time
  • Parse time (top 10 files)
  • Codegen time (top 10 files)
  • Function sets (top 10 compile / optimize)
  • Lines of code
• Testing
  • Running Unit Tests
  • Writing a Unit Test
• Shamrock primitive types
  • Literals
• Solver graph
  • A first node from a simple case
  • Wiring node and edges together
• Solver graph nodes
  • Node layout
  • Optional edges
  • Composition nodes
  • Related files
• Solver graph edges
  • Derive from IEdge
  • Derive from IEdgeNamed
  • Related files
• sham::kernel_call
  • Basic usage
  • MultiRef
  • Under the hood
  • Related variants
  • Related files
• sham::distributed_data_kernel_call
  • Basic usage
  • DDMultiRef
  • Under the hood
  • Related variants
  • Related files
• Implementation selection
  • Current status
  • User side (Python)
  • Developer side (C++)
  • Related files
• Riemann solver implementation notes
  • Axis permutation vs projection
• Profiling
  • Shamrock custom profiling
  • Nvidia profiling
• Profiling build performance / time
  • Compiler peak RSS (memlog)
  • Example output (2026-08-04)
• Release process
  • Changing the version
  • The release branch
  • Creating the release