Release github Code Size Issues github Pull Requests github Last Commit github Contributors github Gitter github Binder github

Welcome to Kassiopeia’s documentation!

Documentation Contents


This simulation package by the KATRIN collaboration allows to run highly customizable particle tracking simulations along with calculations of electric and magnetic fields. Kassiopeia is supported and intended to run on systems running either Linux or MacOS X.

Source Code:

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)

In addition to this user guide, Kassiopeia and its associated libraries have been documented extensively in several PhD theses. Many of these can be found under the list of KATRIN publications.

Docker images

All images:

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. For more information and a guide on how to set up Kassiopeia see chapter Setup via container.