← Back to branch summary

~chris-rogers/maus/emr_mc_digitization

« back to all changes in this revision

Viewing changes to doc/doc_tools/README

  • Committer: Chris Rogers
  • Date: 2014-04-16 11:48:45 UTC
  • mfrom: (707 merge)
  • mto: This revision was merged to the branch mainline in revision 711.
  • Revision ID: chris.rogers@stfc.ac.uk-20140416114845-h3u3q7pdcxkxvovs
Update to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doc_tools/README
 
1
############################################################################
 
2
#                                                                          #
 
3
#   INSTRUCTIONS:                                                          #
 
4
#   1. Run generate_third_party_doc.py                                     #
 
5
#   2. Run generate_MAUS_doc.py                                            #
 
6
#   3. Open ../index.html in order to browse documentation                 #
 
7
#   NOTE: The scripts should always be run from *this* directory           #
 
8
#   (doc/doc_tools/) otherwise the doxygen config file will not be found   #
 
9
#                                                                          #
 
10
############################################################################
 
11
 
 
12
The files "generate_third_party_doc.py" and "generate_MAUS_doc.py" will
 
13
generate the doxygen documentation for third party libraries (currently ROOT,
 
14
Geant4, CLHEP, and JsonCpp) and MAUS (split up into framework, DataStructure,
 
15
Input, Map, Reduce, Output) respectively. Documentations can be browsed via
 
16
doc/index.html which is created at the end of "generate_MAUS_doc.py".
 
17
If your MAUS installation is set up to use third party libaries from elsewhere
 
18
(as given by the environment variable MAUS_THIRD_PARTY), third party
 
19
documentation will be stored there. Paths in index.hthml are automatically
 
20
adjusted.
 
21
Both scripts can be run with the argument --noprompt in order not to prompt for
 
22
confirmation.
 
23
 
 
24
THIRD PARTY DOCUMENTATION HAS TO BE GENERATED BEFORE THE MAUS DOCUMENTATION
 
25
IN ORDER FOR DERIVED CLASSES TO BE INCLUDED PROPERLY.
 
26
 
 
27
Note that dot, part of Graphviz (http://graphviz.org/), has to be installed
 
28
in order for graphs to be generated. You can, however, still generate the
 
29
documentation without it.
 
30
 
 
31
NOTE: There is some seemingly invalid LaTeX code in three of the ROOT source
 
32
files resulting in the image generation for these equations failing when
 
33
creating the ROOT doxygen documentation. The relevant files are in
 
34
third_party/build/root_v5.34.07/include/Math and are named
 
35
VavilovAccurateCdf.h, VavilovAccuratePdf.h, and VavilovAccurateQuantile.h.
 
36
The problematic equation starts on line 53, 51, and 53 respectively. To fix,
 
37
replace with the same equation from VavilovAccurate.h line 50-53, specifically
 
38
remove the ampersands around the "=" in the first line and replace "\der t" by
 
39
"d t" in the third line.
 
40
 
 
41
The directories from which the documentation is created are listed below.
 
42
 
 
43
THIRD PARTY:
 
44
ROOT:           /third_party/build/root_v{version}/include/
 
45
                /third_party/build/root_v{version}/lib/
 
46
Geant4:         /third_party/build/geant{version}/source/
 
47
CLHEP:          /third_party/build/clhep-{version}/
 
48
JsonCpp:        /third_party/build/jsoncpp-src-{version}/include/
 
49
                /third_party/build/jsoncpp-src-{version}/src/;
 
50
 
 
51
MAUS:
 
52
Framework:      /src/common_cpp/ with the exception of /src/common_cpp/DataStructure/
 
53
                /src/common_py/
 
54
                /src/py_cpp/
 
55
                /src/legacy/;
 
56
DataStructure:  /src/common_cpp/DataStructure/
 
57
Input:          /src/input/
 
58
Map:            /src/map/
 
59
Reducer:        /src/reduce/
 
60
Output:         /src/output/