Project

General

Profile

Actions

User Documenation

See issue #179

Documentation should be ready and polished when code goes into code review. Should be in latex format.

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 something like:

Documentation -> Tour (~ few pages) + examples
              -> Operations manual (~ few pages)
              -> Reference -> MiceModules -> geometry
                                          -> fields
                                          -> materials

                           -> configuration datacards

                           -> detectors   -> tracker
                                          -> tof
                                          -> Ckov
                                          -> EMR

                           -> data structure

                           -> analysis stuff? x-boa? optics?

Updated by Rogers, Chris over 9 years ago ยท 3 revisions