Project

General

Profile

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:

  1. Introduction
  2. Data structure/access
  3. API
  4. Monte Carlo
  5. Geometry/CDB interface
  6. MiceModules and geometry editing
  7. Detector reconstruction algorithms
    • Tracker
    • TOF
    • Ckov
    • EMCal
    • KL
    • Global

Currently we are weak on detector reconstruction routines.

Updated by Rogers, Chris over 8 years ago ยท 8 revisions