MAUS Developer Documentation¶

MAUS Documentation¶

• MAUS Overview documentation
  • Overview of MAUS structure
  • Release schedule
  • Data Structure
• Code documentation - doxygen documentation for each class, function, method etc
  • Framework
  • Backend

Development workflow¶

• Coding Standards - minimum requirements for how code should be written
  • Coding style
  • Unit tests
  • Application tests
  • User documentation
  • Code review
• Contributing to MAUS - how to set up bzr and add code to the MAUS repository
  • Development branches of MAUS

Procedures¶

• Release procedure
• Deployment
• Geometry release procedure

• Other stuff:
  • Software Sustainability Institute / MAUS collaboration
    • Reducers and histograms
    • Celery Configuration
    • Document Cache Configuration
    • Third-party online monitoring examples
  • Publications policy
  • Jenkins
  • Additional build flags
  • MAUS_Work_Specification_Template.odt