Documentation Contents
Welcome to Kassiopeia's documentation! <self>
Contact, Meeting and References <contact.rst> License <linktolicense.rst> Authors <authors.rst>
Introduction <introduction.rst> Setup with container <setup_container.rst> Manual installation <setup_manual.rst> Directory structure & environmental variables <directory_structure.rst>
Running Kassiopeia <runningKassiopeia.rst> Example configurations <examples.rst> Configuring your own simulation <configuring_simulation.rst> KGeoBag (geometry) - <geometry> <element_kgeobag.rst> KEMField (fields) - <kemfield> <element_kemfield.rst> Kassiopeia (particles) - <kassiopeia> <element_kassiopeia.rst>
Understanding Simulation Output <output.rst> Additional Simulation Tools <tools.rst> Visualization Techniques <visualization.rst> XML Bindings <bindings.rst>
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: 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.xmlto 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: 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. For more information and a guide on how to set up Kassiopeia see chapter setup-via-container.