MAUSDevs » History » Version 88
Jackson, Mike, 29 March 2012 13:08
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 | 85 | Rogers, Chris | * [[ISIS user run checklist]] |
30 | 12 | Rogers, Chris | |
31 | 68 | Rogers, Chris | h2. Operations |
32 | |||
33 | * [[Software on-call]] |
||
34 | 1 | Rogers, Chris | |
35 | 76 | Jackson, Mike | h2. Online reconstruction |
36 | 59 | Tunnell, Christopher | |
37 | * [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] |
||
38 | 75 | Jackson, Mike | * "Overview talk":https://micewww.pp.rl.ac.uk/attachments/816/20120209-MAUS-SSI-Status.ppt (09/02/12) |
39 | 78 | Jackson, Mike | * [[MAUSOnlineReconstructionOverview|Online reconstruction overview]] |
40 | 74 | Jackson, Mike | * Distributed spill transformation |
41 | ** [[MAUSCeleryConfiguration|How to set up Celery and RabbitMQ]] |
||
42 | ** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] |
||
43 | ** [[MAUSCelery|Celery configuration and monitoring]] |
||
44 | 77 | Jackson, Mike | ** [[MAUSDocumentCacheConfiguration|How to configure MongoDB as a document cache]] |
45 | 88 | Jackson, Mike | ** [[MAUSOnlineReconstructionQuick|Quick start guide]] |
46 | 83 | Jackson, Mike | ** [[MAUSDistributedSpillsClients|Distributed spills transformation clients and tools]] |
47 | 82 | Jackson, Mike | ** [[MAUSCeleryRabbitMQRecovery|Distributed spill transformation troubleshooting and recovery]] |
48 | 74 | Jackson, Mike | * Histogram reducers |
49 | ** [[MAUSHistogramReducers|How to write histogram reducers]] |
||
50 | * Web front-end |
||
51 | 87 | Jackson, Mike | ** [[MAUSWebFrontEndDeploy|How to deploy the MAUS web front-end]] |
52 | 74 | Jackson, Mike | ** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] |
53 | 59 | Tunnell, Christopher | |
54 | h2. Other Information |
||
55 | |||
56 | 50 | Rogers, Chris | * [[Publications policy]] |
57 | * [[Jenkins]] |
||
58 | * [[Additional build flags]] |
||
59 | * attachment:MAUS_Work_Specification_Template.odt |