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
   • An introduction to the test server
5. User documentation
6. Code review
7. Merging code

Procedures¶

• Release procedure
• Deployment
• Geometry release procedure
• ISIS user run checklist

Operations¶

• Software on-call

Online reconstruction¶

• Software Sustainability Institute / MAUS collaboration
• Overview talk (09/02/12)
• Online reconstruction overview
• Distributed spill transformation
  • How to set up Celery and RabbitMQ
  • RabbitMQ configuration and monitoring
  • Celery configuration and monitoring
  • How to configure MongoDB as a document cache
  • Quick start guide
  • Distributed spills transformation clients and tools
  • Distributed spill transformation troubleshooting and recovery
• Histogram reducers
  • How to write histogram reducers
• Web front-end
  • How to deploy the MAUS web front-end
  • Third-party online monitoring examples

Other Information¶

• Gallery
• Publications policy
• Jenkins
• Additional build flags
• We have an IRC channel
• MAUS_Work_Specification_Template.odt