Project

General

Profile

MAUSDevs » History » Version 63

Jackson, Mike, 08 March 2012 10:10

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 1 Rogers, Chris
31 59 Tunnell, Christopher
h2. Software Sustainability Institute / MAUS collaboration
32
33
"Overview talk":https://micewww.pp.rl.ac.uk/attachments/816/20120209-MAUS-SSI-Status.ppt
34
35 50 Rogers, Chris
* [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]]
36 62 Jackson, Mike
** [[MAUSOnlineReconstructionOverview|Online reconstruction overview]] (under development)
37 50 Rogers, Chris
** [[MAUSHistogramReducers|Reducers and histograms]]
38
** [[MAUSCeleryConfiguration|Celery Configuration]]
39 54 Jackson, Mike
** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] (development versions)
40
** [[MAUSCelery|Celery configuration and monitoring]] (development versions)
41
** [[MAUSCeleryRabbitMQRecovery|Celery error detection and recovery]] (development versions)
42 50 Rogers, Chris
** [[MAUSDocumentCacheConfiguration|Document Cache Configuration]]
43 63 Jackson, Mike
** [[MAUSWebFrontEndDeploy|Deploying the MAUS web front-end]]
44 50 Rogers, Chris
** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]]
45 1 Rogers, Chris
** [[MAUSDjangoApache|Deploying Django under Apache]] (under development)
46 59 Tunnell, Christopher
47
h2. Other Information
48
49 50 Rogers, Chris
* [[Publications policy]]
50
* [[Jenkins]]
51
* [[Additional build flags]]
52
* attachment:MAUS_Work_Specification_Template.odt