Welcome to wfsim’s documentation!

Github page: https://github.com/XENONnT/WFSim

WFSim is the wavefrom simulation framework for XENONnT, built on top of the straxen framework.

Installation

See the installation guide

Contents:

• Installing wfsim
• Developer setup

Tutorials:

• Getting started with WFSim
  • Different simulators
  • Setting everything up
  • Defining instructions
  • Configuration customization
  • Things you might want to change
  • What actually happens?
  • Matching
• Externally call functions
• Understanding Waveform Simulation for XENONnT
  • Part 1, Simulation flow
  • Conceptual Overview
  • Between Interface and Core
  • Pulse Classes
  • Workflow Walkthrough
• Understanding Waveform Simulation for XENONnT
  • Part 2, Pulse (parent class)
  • Pulse Class Call Workflow
• Advanced Tricks

Reference

• wfsim package

Indices and tables

• Index

• Module Index

• Search Page