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¶

1. Getting a development branch
   • Development branches of MAUS
2. Coding style
3. Unit tests
4. Application tests
5. User documentation
6. Code review
7. Merging code

Procedures¶

• Release procedure
• Deployment
• Geometry release procedure

Operations¶

• Software on-call

Software Sustainability Institute / MAUS collaboration¶

Overview talk

• Software Sustainability Institute / MAUS collaboration
  • Online reconstruction overview (under development)
  • Distributed spill transformation
    • How to set up Celery and RabbitMQ
    • RabbitMQ configuration and monitoring
    • Celery configuration and monitoring
    • Document cache configuration (under development)
  • Failure detection and recovery
    • Celery error detection and recovery(under development)
  • Histogram reducers
    • How to write histogram reducers
  • Web front-end
    • Deploying the MAUS web front-end (under development)
    • Third-party online monitoring examples

Other Information¶

• Publications policy
• Jenkins
• Additional build flags
• MAUS_Work_Specification_Template.odt