MAUSDevs » History » Revision 88

Revision 87 (Jackson, Mike, 29 March 2012 12:59) → Revision 88/133 (Jackson, Mike, 29 March 2012 13:08)

h1. MAUS Developer Documentation 

 h2. MAUS Documentation 

 * MAUS Overview documentation 
 ** [[System architecture|Overview of MAUS structure]] 
 ** [[Release schedule]] 
 ** [[Data Structure]] 
 * Code documentation - doxygen documentation for each class, function, method etc 
 ** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html 
 ** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html 

 h2. Development workflow  

 # [[Bzr_usage|Getting a development branch]] 
 ** "Development branches of MAUS":https://code.launchpad.net/maus 
 # [[Coding style]] 
 # [[Unit tests]] 
 # [[Application tests]] 
 # [[UserDocumenation|User documentation]] 
 # [[Code review]] 
 # [[Bzr_usage#Merging-changes-from-your-branch-to-the-trunk|Merging code]] 

 h2. Procedures 

 * [[Release procedure]] 
 * [[Deployment]] 
 * [[Geometry release procedure]] 
 * [[ISIS user run checklist]] 

 h2. Operations 

 * [[Software on-call]] 

 h2. Online reconstruction 

 * [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] 
 * "Overview talk":https://micewww.pp.rl.ac.uk/attachments/816/20120209-MAUS-SSI-Status.ppt (09/02/12) 
 * [[MAUSOnlineReconstructionOverview|Online reconstruction overview]] 
 * Distributed spill transformation 
 ** [[MAUSCeleryConfiguration|How to set up Celery and RabbitMQ]]  
 ** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] 
 ** [[MAUSCelery|Celery configuration and monitoring]] 
 ** [[MAUSDocumentCacheConfiguration|How to configure MongoDB as a document cache]] 
 ** [[MAUSOnlineReconstructionQuick|Quick start guide]] 
 ** [[MAUSDistributedSpillsClients|Distributed spills transformation clients and tools]] 
 ** [[MAUSCeleryRabbitMQRecovery|Distributed spill transformation troubleshooting and recovery]] 
 * Histogram reducers 
 ** [[MAUSHistogramReducers|How to write histogram reducers]] 
 * Web front-end 
 ** [[MAUSWebFrontEndDeploy|How to deploy the MAUS web front-end]] 
 ** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] 

 h2. Other Information 

 * [[Publications policy]] 
 * [[Jenkins]] 
 * [[Additional build flags]] 
 * attachment:MAUS_Work_Specification_Template.odt