Project

General

Profile

MAUSUser » History » Revision 25

Revision 24 (Tunnell, Christopher, 23 August 2011 18:02) → Revision 25/28 (Tunnell, Christopher, 14 September 2011 12:40)

{{toc}} 

 h1. MAUS User Documentation 

 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. 

 h2. Offline data access 

 To get at the MICE data, look here: 

 http://micewww.pp.rl.ac.uk/projects/computing-software/wiki 

 h2. Applications 

 There are several applications in the MAUS schema 

 h2. Getting Help 

 When filling out a support request, you will almost certainly be asked some of the following information so it is useful for us if you try to answer as many of the questions as possible from the list below. 

 # What version of MAUS are you using?    Are you using the trunk or a release?    If you are using your own branch, where can we see the code and what have you changed?    Is it reproducible in the trunk? 
 # What version of Linux or Mac are you using?    What distribution? 
 # What version of gcc are you using: <pre>g++ --version</pre> 
 # If you are seeing weird behavior when running a command, please send us the output file and also the terminal output.    You can pipe terminal output to a file by doing for example: <pre>my_application.py 1>maus_standard_output 2>maus_standard_errors</pre> 

 After making an effort to answer these questions, please post your support query to the "support tracker":http://micewww.pp.rl.ac.uk/projects/maus/issues/new where somebody will answer your questions. 

 Please *do not* email the code maintainers directly because we will send you to this webpage and frequently accidentally miss emails.    This website is the way you are not forgotten. 

 h2. Configuration manipulation 

 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. 

 * 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. 
 * Documentation on global run controls is available in "html":http://www.mice.iit.edu/software/g4mice_doc/datacards-2-4-1.html format. 
 * [[Materials-2-4-1|List of valid materials]] 

 h2. Changing application modules 

 MAUS uses a modular structure in its applications. Uses can alter the modules which a particular application runs or define their own application. The different modules are listed in the [[Components]] section. 

 h2. File IO 

 Data is passed between different parts of the framework in tree-like structured data files. The tree structure is described in the [[DataStructure]] section.