Welcome to Kassiopeia’s documentation!#
Documentation Contents
- Introduction
- References, Citation and Contact
- Getting Started
- Examples and Tests
- Configuring Your Own Simulation
- Basic KGeoBag Shapes
- Complex KGeoBag Shapes
- Understanding Simulation Output
- Additional Simulation Tools
- Visualization Techniques
- XML Bindings
- License
- Authors
This simulation package by the KATRIN collaboration allows to run highly customizable particle tracking simulations along with calculations of electric and magnetic fields.
Source Code: https://github.com/KATRIN-Experiment/Kassiopeia
Quick start: Try it out online in an interactive Binder session. Open a “VNC (Desktop)” tab and a terminal tab and run
Kassiopeia $KASPERSYS/config/Kassiopeia/Examples/DipoleTrapSimulation.xml
to run your first simulation! Note: A VTK error indicates that the “VNC (Desktop)” tab is not open yet.
Cite our paper:
D. Furse et al. (2017) New J. Phys. 19 053012: “Kassiopeia: A Modern, Extensible C++ Particle Tracking Package” (doi:10.1088/1367-2630/aa6950)
Docker images#
All images: https://github.com/orgs/KATRIN-Experiment/packages
The kassiopeia/full image comes with a JupyterLab installation, can run on Kubernetes based JupyterHubs and is also used for the “try it out online” link above.