Project

General

Profile

MAUSUser » History » Version 12

Rogers, Chris, 12 April 2011 09:57

1 1 Rogers, Chris
h1. MAUS User Documentation
2
3 4 Rogers, Chris
MAUS usage is handled by several applications that enable basic usage of the framework. Each application runs several modules against a particular configuration. The particular modules that the application runs, and the configuration that is run against, can all be modified by the user.
4
5 1 Rogers, Chris
h2. Applications
6
7 2 Rogers, Chris
There are several applications in the MAUS schema:
8
9 6 Rogers, Chris
* *Simulation* tracks particles through a given geometry. Simulation uses the following modules
10 5 Rogers, Chris
** _BeamGenerator_ generates a beam as defined by the user
11
** _ReferenceParticle_ pushes a single particle through the geometry to phase the cavities
12
** _Tracking_ pushes particles through the geometry
13
** _VirtualPlanes_ extracts information on particle tracks as they cross flat planes in space or time.
14 2 Rogers, Chris
15 1 Rogers, Chris
h2. Configuration manipulation
16
17
MAUS uses a set of user-modifiable files to control the application configuration. Variables such as input geometry, field arrangement and detector parameters can all be modified by the user.
18
19
* Documentation on geometry file generation is available in "pdf":http://www.mice.iit.edu/software/g4mice_doc/Mice_Module-2-4-1.pdf or "html":http://www.mice.iit.edu/software/g4mice_doc/Mice_Module-2-4-1.html format.
20
* Documentation on global run controls is available in "html":http://www.mice.iit.edu/software/g4mice_doc/datacards-2-4-1.html format.
21
* [[Materials-2-4-1|List of valid materials]]
22
23
h2. Changing application modules
24
25 2 Rogers, Chris
MAUS uses a modular structure in its applications. Uses can alter the modules which a particular application runs or define their own application. Modules are of several types.
26 1 Rogers, Chris
27
* _Maps_ are executed once per spill and manipulate the spill data in some way (for example, try to do pattern recognition on tracker digits).
28
* _Reduces_ are executed once per run and manipulate all the spills in some way (for example, make a histogram of the tracker light yield).
29 11 Rogers, Chris
* _Runners_ control how Maps and Reduces are executed (for example controlling multithreading or doing some optimisation).
30 7 Rogers, Chris
31 12 Rogers, Chris
The different modules are listed in the [[Components]] section.