Wiki » History » Revision 28

Revision 27 (Rogers, Chris, 16 April 2013 16:23) → Revision 28/29 (Rogers, Chris, 04 March 2015 07:31)

h1. XBOA 

 A multiparticle tracking postprocessor library for accelerator physicsists. You'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! 

 h2. Download and Installation 

 "*Download xboa*": 

 Alternately try "sourceforge": and "launchpad": mirrors. 

 Installation instructions are in the README file, but you probably have to do something like: 

 tar -xzf xboa-<version>.tar.gz 
 cd xboa-<version> 
 # next line may need superuser privileges if installing into the system python install 
 python install 

 At the moment only Linux is supported, but windows support could be implemented if there was demand. 

 h2. Running 

 When 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. 

 There are several example scripts in the directory xboa-<version>/xboa/examples that are good to start with. They take you through the steps required to load particle tracking data, access it, make plots and manipulate it in various ways. Reference documentation is in the directory xboa-<version>/doc. Browse the example script code at: 

 "Example 1": 
 "Example 2": 
 "Example 3": 
 "Example 4": 

 There is also a script that _almost_ clones the functionality of the ecalc9f code developed by Greg Penn and Rick Fernow: 


 h2. Documentation 

 Please see the "full documentation": 

 [[developer|Developer documentation]]