2\mainpage XBOA: A multiparticle tracking postprocessor library for accelerator physicsists
3You've got your favourite tracking code running, what now? This package is a post-processor for taking beam data to calculate beam emittance, Twiss functions, etc. Also includes bindings to plotting packages ROOT and matplotlib, and a whole lot more!
4
5\par Download and Installation
6You can download the latest version from the code repository hosted on <a href="http://sourceforge.net/projects/xboa/">sourceforge</a>. This is mirrored on <a href="http://launchpad.net/xboa">launchpad</a>.
7
8\par
9Installation instructions are in the README file, but you probably have to do something like:
10
11\par
12\code
13tar -xzf xboa-<version>.tar.gz
14cd xboa-<version>
15python setup.py build
16sudo python setup.py install
17\endcode
18
19\par
20At the moment only Linux is supported, but windows support would be pretty easy to implement if there was demand.
21
22\par Running
23When doing any physics analysis beyond the most basic, one really wants to be able to manipulate the analysis in various ways. For any detailed analysis, physicists will want to make cuts and calculate different variables in different ways. For this reason x-boa really provides just a library of physics analysis functions. Examples of how to use it are provided, but once physicists get going they can really push the analysis however they like.
24
25\par Examples
26There are several example scripts in the xboa/examples directory that are good to start with:
27\li \link xboa::examples::Example_1 xboa/examples/Example_1.py \endlink Load and access particle data
28\li \link xboa::examples::Example_2 xboa/examples/Example_2.py \endlink Load data and make some plots
29\li \link xboa::examples::Example_3 xboa/examples/Example_3.py \endlink Make some cuts before plotting
30\li \link xboa::examples::Example_4 xboa/examples/Example_4.py \endlink Apply a transformation before plotting
31\li \link xboa::examples::closed_orbit xboa/examples/closed_orbit.py \endlink Find a closed orbit
32
33\par
34They take you through the steps required to load particle tracking data, access it, make plots and manipulate it in various ways. There is also a script that _almost_ clones the functionality of the ecalc9f code developed by Greg Penn and Rick Fernow, XBOA9f.py
35
36\par Modules
37Three modules are available
38\li \link xboa::common::_common common \endlink contains some useful general purpose routines including general plotting routines
39\li \link xboa::hit hit \endlink module provides the \link xboa::hit::_hit::Hit Hit \endlink class and other interfaces to individual monte carlo Hits (e.g. particles traversing some output plane)
40\li \link xboa::bunch bunch \endlink module provides the \link xboa::bunch::_bunch::Bunch Bunch \endlink class and other interfaces to operations on groups of particles (e.g. moment and Twiss parameter calculation)
41\li \link xboa::tracking tracking \endlink provides an interface to tracking for use by the algorithms module
42\li \link xboa::algorithms algorithms \endlink provides a library many for common accelerator physics functions such as finding closed orbits
43
44Additionally, there is some C code hiding "under the bonnet"
45
46\authors Chris Rogers chris.rogers@stfc.ac.uk
47*/
Generated on Fri Mar 6 2015 10:37:17 for xboa by 1.8.6