Project

General

Profile

MAUSDevs » History » Version 94

Rogers, Chris, 30 October 2012 10:01

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 94 Rogers, Chris
** [[Jenkins|An introduction to the test server]]
21 48 Rogers, Chris
# [[UserDocumenation|User documentation]]
22
# [[Code review]]
23 49 Rogers, Chris
# [[Bzr_usage#Merging-changes-from-your-branch-to-the-trunk|Merging code]]
24 43 Rogers, Chris
25
h2. Procedures
26
27
* [[Release procedure]]
28
* [[Deployment]]
29
* [[Geometry release procedure]]
30 85 Rogers, Chris
* [[ISIS user run checklist]]
31 12 Rogers, Chris
32 68 Rogers, Chris
h2. Operations
33
34
* [[Software on-call]]
35 1 Rogers, Chris
36 76 Jackson, Mike
h2. Online reconstruction
37 59 Tunnell, Christopher
38
* [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]]
39 75 Jackson, Mike
* "Overview talk":https://micewww.pp.rl.ac.uk/attachments/816/20120209-MAUS-SSI-Status.ppt (09/02/12)
40 78 Jackson, Mike
* [[MAUSOnlineReconstructionOverview|Online reconstruction overview]]
41 74 Jackson, Mike
* Distributed spill transformation
42
** [[MAUSCeleryConfiguration|How to set up Celery and RabbitMQ]] 
43
** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]]
44
** [[MAUSCelery|Celery configuration and monitoring]]
45 77 Jackson, Mike
** [[MAUSDocumentCacheConfiguration|How to configure MongoDB as a document cache]]
46 88 Jackson, Mike
** [[MAUSOnlineReconstructionQuick|Quick start guide]]
47 83 Jackson, Mike
** [[MAUSDistributedSpillsClients|Distributed spills transformation clients and tools]]
48 82 Jackson, Mike
** [[MAUSCeleryRabbitMQRecovery|Distributed spill transformation troubleshooting and recovery]]
49 74 Jackson, Mike
* Histogram reducers
50
** [[MAUSHistogramReducers|How to write histogram reducers]]
51
* Web front-end
52 87 Jackson, Mike
** [[MAUSWebFrontEndDeploy|How to deploy the MAUS web front-end]]
53 74 Jackson, Mike
** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]]
54 59 Tunnell, Christopher
55
h2. Other Information
56
57 91 Rogers, Chris
* [[Gallery]]
58 50 Rogers, Chris
* [[Publications policy]]
59
* [[Jenkins]]
60
* [[Additional build flags]]
61 90 Rogers, Chris
* We have an [[ircchannel|IRC channel]]
62 50 Rogers, Chris
* attachment:MAUS_Work_Specification_Template.odt