User:Difalco/sim Gen Template: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
::commented list of references focusing on what is used in the code | ::commented list of references focusing on what is used in the code | ||
* <b>Simulation workflow</b>: | * <b>Simulation workflow</b>: | ||
::description of stages, generator cuts, event weights, modules and fcl files | ::description of stages, generator cuts, event weights, modules and fcl files, outputs | ||
* <b>Available datasets</b>: | * <b>Available datasets</b>: | ||
::list of updated datasets (current and obsolete) with description | ::list of updated datasets (current and obsolete) with description |
Latest revision as of 15:23, 7 May 2024
Template for documenting a generator
The documentation should cover (when applicable):
- Channel description and its physics interest:
- why we want to simulate this channel and its impact on possible Mu2e publications
- Existing measurements:
- list of available measurements with references and comments
- Existing theoretical models:
- commented list of references focusing on what is used in the code
- Simulation workflow:
- description of stages, generator cuts, event weights, modules and fcl files, outputs
- Available datasets:
- list of updated datasets (current and obsolete) with description
- Discussion of systematic uncertainties:
- include uncertainties on the theoretical models or due to approximations implemented at the generation level (e.g. resampling)
- Requests to Simulation group:
- keep track of requests from analysis groups
- List of on going activities:
- who is doing what
- List of References:
- list of relevant papers, internal notes, Thesis relevant for the channel simulation
- Contacts:
- who to contact in case of need (they could redirect you to experts who contributed to the generator)