polematrix

a spin tracking code for electron accelerators using Elegant

Copyright (C) 2017 Jan Felix Schmidt [email protected], GNU General Public License

polematrix is a spin tracking code. It calculates the motion of the spin of ultra relativistic electrons in particle accelerators. It implements a simple matrix tracking as multi-thread C++ application. The input can be any lattice file from Elegant or Mad-X. All required particle trajectories are also imported from the established particle tracking codes Elegant or Mad-X.

polematrix includes synchrotron radiation via import from Elegant or an own implementation of longitudinal phasespace. polematrix is described in my phd thesis (in German). A short (english) description is also published in this IPAC'16 contribution.

The documentation includes more detailed installation instructions, a configuration reference and a brief introduction to the concept of polematrix.

Do not hesitate to contact me if you have any questions and please report bugs. A user guide is coming soon.

Installation

Dependencies:

• CMake
• Gnu Scientific Library (GSL)
• Boost program options
• Boost filesystem
• Boost property tree
• Boost random
• Armadillo library
• palattice library

So far, polematrix was tested only with GCC compiler under Ubuntu/Debian Linux.

Compile & Install:

cd polematrix/build
cmake ..
make
sudo make install

Usage

polematrix [CONFIGURATION FILE] [options]

[CONFIGURATION FILE] is an easy to read xml file, which holds the tracking parameters. They are all described in the documentation. A template configuration file can be generated with option --template.

Allowed options:

Program modes:

-h [ --help ]                  display this help message
-V [ --version ]               display version
-T [ --template ]              create config file template (template.pole) and quit
-R [ --resonance-strengths ]   estimate strengths of depolarizing resonances

Configuration options:

-t [ --threads ] arg (=all)    number of threads used for tracking
-o [ --output-path ] arg (=.)  path for output files
-v [ --verbose ]               more output, e.g. each written spin file
-n [ --no-progressbar ]        do not show progress bar during tracking
-a [ --all ]                   write all output (e.g. lattice and orbit)
-s [ --spintune ] arg	       in resonance-strengths mode: calculate for given spin tune only