Skip to content

Quick Start Guide

nsoblath edited this page May 7, 2014 · 9 revisions

This quick-start guide will demonstrate how to build a particle-tracking simulation using Kassiopeia. We will use the Quadrupole Trap example that is included with the Kassiopeia distribution.

The operation of Kassiopeia is specified using configuration files written in XML format. The configuration files for the Quadrupole Trap example can be found in the install directory, at config/Kassiopeia/QuadrupoleTrap (or in the source directory at Kassiopeia/XML/QuadrupoleTrap).

The quadrupole trap consists of endcap and ring electrodes that combine to produce a quadrupole-shaped electric field, plus a large solenoidal magnet that produces a uniform axial magnetic field. We will simulate a number of trapped electrons traveling within the trap. We will use the visualization tools available with Kassiopeia to look at the physical setup, and to see the results of the simulation.

The configuration for the quadrupole trap example is divided into three configuration files for organizational convenience: , , and the simulation is configured in QuadrupoleTrapSimulation.xml.

The physical setup of the simulation is described in QuadrupoleTrapBasicGeometry.xml. The basic shapes are defined, and concrete objects are placed in the simulation space.

Appearance and electromagnetic properties are added to the geometric elements in QuadrupoleTrapExtendedGeometry.xml.

The field and tracking simulations are defined in QuadrupoleTrapSimulation.xml. This includes the electromagnetic field solvers, particle generation,