xboa
__init__.py
Go to the documentation of this file.
1 # This file is a part of xboa
2 #
3 # xboa is free software: you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation, either version 3 of the License, or
6 # (at your option) any later version.
7 #
8 # xboa is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with xboa in the doc folder. If not, see
15 # <http://www.gnu.org/licenses/>.
16 
17 """
18 \namespace xboa
19 
20 XBOA - Cross-Platform Beam Optics Analysis
21 A multiparticle tracking postprocessor library for accelerator physicists.
22 
23 You\'ve got your favourite tracking code running, what now? This package is a
24 post-processor for taking beam data to calculate emittance, Twiss functions,
25 etc. Also includes bindings to plotting packages ROOT and matplotlib, and a
26 whole lot more!
27 
28 """
29 
30 
31 __all__ = ['bunch', 'hit', 'Common', 'tracking', 'algorithms']
32