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::tracking
19 
20 The tracking module holds classes related to tracking interfaces for various
21 Monte Carlo codes. The tracking interface enables the user to implement basic
22 tracking for using xboa algorithms against different codes.
23 
24 Implemented within this module:
25 \li \link xboa::tracking::_tracking_base::TrackingBase TrackingBase \endlink: base class that defines an interface suitable for use within the
26  tracking module
27 \li \link xboa::tracking::_maus_tracking::MAUSTracking MAUSTracking \endlink: a tracking class that provides an interface to the MAUS tracking
28  library
29 \li \link xboa::tracking::_matrix_tracking::MatrixTracking MatrixTracking \endlink: a tracking class that provides an interface to "tracking"
30  using simple transfer matrices
31 """
32 
33 from _matrix_tracking import MatrixTracking
34 from _maus_tracking import MAUSTracking
35 from _tracking_base import TrackingBase
36 
37 __all__ = ["MatrixTracking", "MAUSTracking", "TrackingBase"]
38