MAUSDevs » History » Version 73
Jackson, Mike, 15 March 2012 13:46
1 | 1 | Rogers, Chris | h1. MAUS Developer Documentation |
---|---|---|---|
2 | |||
3 | 43 | Rogers, Chris | h2. MAUS Documentation |
4 | |||
5 | 27 | Rogers, Chris | * MAUS Overview documentation |
6 | ** [[System architecture|Overview of MAUS structure]] |
||
7 | ** [[Release schedule]] |
||
8 | 39 | Rogers, Chris | ** [[Data Structure]] |
9 | 10 | Rogers, Chris | * Code documentation - doxygen documentation for each class, function, method etc |
10 | 3 | Rogers, Chris | ** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html |
11 | 4 | Rogers, Chris | ** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html |
12 | 42 | Rogers, Chris | |
13 | h2. Development workflow |
||
14 | |||
15 | 48 | Rogers, Chris | # [[Bzr_usage|Getting a development branch]] |
16 | 10 | Rogers, Chris | ** "Development branches of MAUS":https://code.launchpad.net/maus |
17 | 48 | Rogers, Chris | # [[Coding style]] |
18 | # [[Unit tests]] |
||
19 | # [[Application tests]] |
||
20 | # [[UserDocumenation|User documentation]] |
||
21 | # [[Code review]] |
||
22 | 49 | Rogers, Chris | # [[Bzr_usage#Merging-changes-from-your-branch-to-the-trunk|Merging code]] |
23 | 43 | Rogers, Chris | |
24 | h2. Procedures |
||
25 | |||
26 | * [[Release procedure]] |
||
27 | * [[Deployment]] |
||
28 | * [[Geometry release procedure]] |
||
29 | 12 | Rogers, Chris | |
30 | 68 | Rogers, Chris | h2. Operations |
31 | |||
32 | * [[Software on-call]] |
||
33 | 1 | Rogers, Chris | |
34 | 59 | Tunnell, Christopher | h2. Software Sustainability Institute / MAUS collaboration |
35 | |||
36 | "Overview talk":https://micewww.pp.rl.ac.uk/attachments/816/20120209-MAUS-SSI-Status.ppt |
||
37 | |||
38 | 50 | Rogers, Chris | * [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] |
39 | 62 | Jackson, Mike | ** [[MAUSOnlineReconstructionOverview|Online reconstruction overview]] (under development) |
40 | 69 | Jackson, Mike | ** Distributed spill transformation |
41 | 71 | Jackson, Mike | *** [[MAUSCeleryConfiguration|How to set up Celery and RabbitMQ]] |
42 | *** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] |
||
43 | *** [[MAUSCelery|Celery configuration and monitoring]] |
||
44 | 1 | Rogers, Chris | *** [[MAUSDocumentCacheConfiguration|Document cache configuration]] (under development) |
45 | 73 | Jackson, Mike | ** Failure detection and recovery |
46 | 72 | Jackson, Mike | *** [[MAUSCeleryRabbitMQRecovery|Celery error detection and recovery]](under development) |
47 | 69 | Jackson, Mike | ** Histogram reducers |
48 | *** [[MAUSHistogramReducers|How to write histogram reducers]] |
||
49 | ** Web front-end |
||
50 | *** [[MAUSWebFrontEndDeploy|Deploying the MAUS web front-end]] (under development) |
||
51 | *** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] |
||
52 | 59 | Tunnell, Christopher | |
53 | h2. Other Information |
||
54 | |||
55 | 50 | Rogers, Chris | * [[Publications policy]] |
56 | * [[Jenkins]] |
||
57 | * [[Additional build flags]] |
||
58 | * attachment:MAUS_Work_Specification_Template.odt |