Difference between revisions of "MOLLERsim application coding guidelines"

From Hall A Wiki
Jump to: navigation, search
(General)
Line 14: Line 14:
 
## update your version and make sure your changes work with the latest version before committing
 
## update your version and make sure your changes work with the latest version before committing
  
==Notes==
 
{{reflist|group=Note|refs=
 
<ref name=Note01>But Miller points out that the Sun is not as large as some other stars.</ref>
 
<ref name=Note02>The Moon goes by other names, such as Selena.</ref>
 
<ref name=Note03>Historically the Moon was not always considered to be large.</ref>
 
}}
 
 
==References==
 
{{reflist|refs=
 
<ref name=Foot01>Miller, ''The Sun'', Oxford, 2005, p. 23.</ref>
 
<ref name=Foot02>Brown, ''The Moon'', 2006, Penguin, p. 46.</ref>
 
<ref name=Foot03>Smith, ''The Universe'', Random House, 2005, p. 334.</ref>
 
}}
 
  
 
== Geometry ==
 
== Geometry ==

Revision as of 10:27, 4 December 2012

General

  1. comment for DOxygen
  2. use object-oriented code
  3. use GEANT4 classes - don't reinvent the wheel
  4. guarantee that it works on the farm
    1. use "central" GEANT4 installation
      1. We like OpenInventor?
      2. We want to be able to use GNUMake?
    2. if someone gets it working on other platforms, may offer support
  5. when you make a change, you need to make sure that it works!
    1. on the farm...
    2. with the "approved" environment variables
    3. update your version and make sure your changes work with the latest version before committing


Geometry

  1. use GDML (need to decide about how to do modular geometry)
  2. hard-code materials?
  3. parameterize where possible

Generators

Analysis

  1. Define tracking in correct places (step, event, run, etc.)