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 Standards - minimum requirements for how code should be written
3. Coding style
4. Unit tests
5. Application tests
6. User documentation
7. Code review
8. Merging code

Procedures¶

• Release procedure
• Deployment
• Geometry release procedure

Other Information¶

• Software Sustainability Institute / MAUS collaboration
  • Reducers and histograms
  • Celery Configuration
  • RabbitMQ configuration and monitoring (development versions)
  • Celery configuration and monitoring (development versions)
  • Celery error detection and recovery (development versions)
  • Document Cache Configuration
  • Third-party online monitoring examples
  • Deploying Django under Apache (under development)
  • Deploying Django web-front end (under development)
• Publications policy
• Jenkins
• Additional build flags
• MAUS_Work_Specification_Template.odt