Actions
Documentation¶
Documentation should be written in latex. Latex source is in doc/doc_src/
. Block diagrams should be made using graphviz (dot format) and the dot source file should be included with the latex source.
Latex:
- converts to pdf
- converts to html
- can be modular
- can be included in theses/technical notes/etc
- can be generated/edited by scripts
Structure is:
- Introduction
- Data structure/access
- API
- Monte Carlo
- Geometry/CDB interface
- MiceModules and geometry editing
- Detector reconstruction algorithms
- Tracker
- TOF
- Ckov
- EMCal
- KL
- Global
Currently we are weak on detector reconstruction routines.
Updated by Rogers, Chris almost 11 years ago ยท 8 revisions