mainpage.h
1 /**
2 
3  @mainpage C++ Interface to PHOTOS
4  @brief Description of PHOTOS Interface in C++
5 
6  @authors Nadia Davidson, Tomasz Przedzinski, Zbigniew Was
7 
8  @section download1 New release
9 
10  The source code and documentation for release 3.64. The following files are provided for download:
11  - <a href="resources/PHOTOS.3.64/Photos_interface_design.3.64.pdf">Photos_interface_design.pdf</a> full software documentation.
12  - <a href="resources/PHOTOS.3.64/PHOTOS.3.64.tar.gz">PHOTOS 3.64 source code </a> tarball
13  ( <a href="resources/PHOTOS.3.64/PHOTOS.3.64-LHC.tar.gz"> version for LHC/LCG</a> installation)
14  and its <a href="resources/PHOTOS.3.64/svn_info_photos.3.64.txt">revision info</a> SVN tag, tarball creation date/time, etc.
15  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.64/changelog.3.64.txt">changelog.txt</a>
16 
17  <b>IMPORTANT NOTE:</b> Since release 3.64 we have added HepMC3 support (HepMC3 is avialble on the official <a href="https://hepmc.web.cern.ch/hepmc/">HepMC website</a>).
18  We have also adapted examples to Tauola v1.1.8 which means <b>Tauola examples and tests will not compile with Tauola v1.1.6 or older</b>.
19 
20  @section developement Developement version
21 
22  The source code and documentation are updated daily from the repository. The following files are provided for download of the developement version:
23  - <a href="resources/PHOTOS.development.version/Photos_interface_design.development.version.pdf">Photos_interface_design.pdf</a> full software documentation.
24  - <a href="resources/PHOTOS.development.version/PHOTOS.development.version.tar.gz">PHOTOS development version source code </a> tarball
25  ( <a href="resources/PHOTOS.development.version/PHOTOS.development.version-LHC.tar.gz"> version for LHC/LCG</a> installation)
26  and its <a href="resources/PHOTOS.development.version/svn_info_photos.development.version.txt">revision info</a> SVN tag, tarball creation date/time, etc.
27  For updates with respect to release 3.0 see <a href="resources/PHOTOS.development.version/changelog.development.version.txt">changelog.txt</a>.
28 
29  @section download Older releases
30 
31  The source code and documentation for release 3.61. The following files are provided for download:
32  - <a href="resources/PHOTOS.3.61/Photos_interface_design.3.61.pdf">Photos_interface_design.pdf</a> full software documentation.
33  - <a href="resources/PHOTOS.3.61/PHOTOS.3.61.tar.gz">PHOTOS 3.61 source code </a> tarball
34  ( <a href="resources/PHOTOS.3.61/PHOTOS.3.61-LHC.tar.gz"> version for LHC/LCG</a> installation)
35  and its <a href="resources/PHOTOS.3.61/svn_info_photos.3.61.txt">revision info</a> SVN tag, tarball creation date/time, etc.
36  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.61/changelog.3.61.txt">changelog.txt</a>
37 
38  The source code and documentation for release 3.60 (not suitable for EvtGen interface). The following files are provided for download:
39  - <a href="resources/PHOTOS.3.60/Photos_interface_design.3.60.pdf">Photos_interface_design.pdf</a> full software documentation.
40  - <a href="resources/PHOTOS.3.60/PHOTOS.3.60.tar.gz">PHOTOS 3.60 source code </a> tarball
41  ( <a href="resources/PHOTOS.3.60/PHOTOS.3.60-LHC.tar.gz"> version for LHC/LCG</a> installation)
42  and its <a href="resources/PHOTOS.3.60/svn_info_photos.3.60.txt">revision info</a> SVN tag, tarball creation date/time, etc.
43  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.60/changelog.3.60.txt">changelog.txt</a>
44 
45  The source code and documentation for release 3.56. The following files are provided for download:
46  - <a href="resources/PHOTOS.3.56/Photos_interface_design.3.56.pdf">Photos_interface_design.pdf</a> full software documentation.
47  - <a href="resources/PHOTOS.3.56/PHOTOS.3.56.tar.gz">PHOTOS 3.56 source code </a> tarball
48  ( <a href="resources/PHOTOS.3.56/PHOTOS.3.56-LHC.tar.gz"> version for LHC/LCG</a> installation)
49  and its <a href="resources/PHOTOS.3.56/svn_info_photos.3.56.txt">revision info</a> SVN tag, tarball creation date/time, etc.
50  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.56/changelog.3.56.txt">changelog.txt</a>
51 
52  The source code and documentation for release 3.55. The following files are provided for download:
53  - <a href="resources/PHOTOS.3.55/Photos_interface_design.3.55.pdf">Photos_interface_design.pdf</a> full software documentation.
54  - <a href="resources/PHOTOS.3.55/PHOTOS.3.55.tar.gz">PHOTOS 3.55 source code </a> tarball
55  ( <a href="resources/PHOTOS.3.55/PHOTOS.3.55-LHC.tar.gz"> version for LHC/LCG</a> installation)
56  and its <a href="resources/PHOTOS.3.55/svn_info_photos.3.55.txt">revision info</a> SVN tag, tarball creation date/time, etc.
57  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.55/changelog.3.55.txt">changelog.txt</a>
58 
59  The source code and documentation for release 3.54. The following files are provided for download:
60  - <a href="resources/PHOTOS.3.54/Photos_interface_design.3.54.pdf">Photos_interface_design.pdf</a> full software documentation.
61  - <a href="resources/PHOTOS.3.54/PHOTOS.3.54.tar.gz">PHOTOS 3.54 source code </a> tarball
62  ( <a href="resources/PHOTOS.3.54/PHOTOS.3.54-LHC.tar.gz"> version for LHC/LCG</a> installation)
63  and its <a href="resources/PHOTOS.3.54/svn_info_photos.3.54.txt">revision info</a> SVN tag, tarball creation date/time, etc.
64  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.54/changelog.3.54.txt">changelog.txt</a>
65 
66  The source code and documentation for release 3.52. The following files are provided for download:
67  - <a href="resources/PHOTOS.3.52/Photos_interface_design.3.52.pdf">Photos_interface_design.pdf</a> full software documentation.
68  - <a href="resources/PHOTOS.3.52/PHOTOS.3.52.tar.gz">PHOTOS 3.52 source code </a> tarball
69  ( <a href="resources/PHOTOS.3.52/PHOTOS.3.52-LHC.tar.gz"> version for LHC/LCG</a> installation)
70  and its <a href="resources/PHOTOS.3.52/svn_info_photos.3.52.txt">revision info</a> SVN tag, tarball creation date/time, etc.
71  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.52/changelog.3.52.txt">changelog.txt</a>
72 
73  The source code and documentation for release 3.51. The following files are provided for download:
74  - <a href="resources/PHOTOS.3.51/Photos_interface_design.3.51.pdf">Photos_interface_design.pdf</a> full software documentation.
75  - <a href="resources/PHOTOS.3.51/PHOTOS.3.51.tar.gz">PHOTOS 3.51 source code </a> tarball
76  ( <a href="resources/PHOTOS.3.51/PHOTOS.3.51-LHC.tar.gz"> version for LHC/LCG</a> installation)
77  and its <a href="resources/PHOTOS.3.51/svn_info_photos.3.51.txt">revision info</a> SVN tag, tarball creation date/time, etc.
78  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.51/changelog.3.51.txt">changelog.txt</a>
79 
80  The source code and documentation for release 3.5. The following files are provided for download:
81  - <a href="resources/PHOTOS.3.5/Photos_interface_design.3.5.pdf">Photos_interface_design.pdf</a> full software documentation.
82  - <a href="resources/PHOTOS.3.5/PHOTOS.3.5.tar.gz">PHOTOS 3.5 source code </a> tarball
83  ( <a href="resources/PHOTOS.3.5/PHOTOS.3.5-LHC.tar.gz"> version for LHC/LCG</a> installation)
84  and its <a href="resources/PHOTOS.3.5/svn_info_photos.3.5.txt">revision info</a> SVN tag, tarball creation date/time, etc.
85  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.5/changelog.3.5.txt">changelog.txt</a>
86 
87  The source code and documentation for release 3.4. The following files are provided for download:
88  - <a href="resources/PHOTOS.3.4/Photos_interface_design.3.4.pdf">Photos_interface_design.pdf</a> full software documentation.
89  - <a href="resources/PHOTOS.3.4/PHOTOS.3.4.tar.gz">PHOTOS 3.4 source code </a> tarball
90  ( <a href="resources/PHOTOS.3.4/PHOTOS.3.4-LHC.tar.gz"> version for LHC/LCG</a> installation)
91  and its <a href="resources/PHOTOS.3.4/svn_info_photos.3.4.txt">revision info</a> SVN tag, tarball creation date/time, etc.
92  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.4/changelog.3.4.txt">changelog.txt</a>
93  - NEW: methods to correct content of event record: (i) mass (ii) add history entries (iii) program is still not ready to work
94  for cases when in vertex some daughters are history and some other are not.
95 
96  The source code and documentation for release 3.3. The following files are provided for download:
97  - <a href="resources/PHOTOS.3.3/Photos_interface_design.3.3.pdf">Photos_interface_design.pdf</a> full software documentation.
98  - <a href="resources/PHOTOS.3.3/PHOTOS.3.3.tar.gz">PHOTOS 3.3 source code </a> tarball
99  ( <a href="resources/PHOTOS.3.3/PHOTOS.3.3-LHC.tar.gz"> version for LHC/LCG</a> installation)
100  and its <a href="resources/PHOTOS.3.3/svn_info_photos.3.3.txt">revision info</a> SVN tag, tarball creation date/time, etc.
101  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.3/changelog.3.3.txt">changelog.txt</a>
102  - NEW: NLO in decays of Z, W and B (K) --> 2 scalar, <a href="http://annapurna.ifj.edu.pl/~wasm/phNLO.htm">photos NLO tests</a>.
103 
104 
105  The source code and documentation for release 3.0. The following files are provided for download:
106  - <a href="http://arxiv.org/abs/1011.0937">arXiv:1011.0937</a> full software documentation.
107  - <a href="resources/PHOTOS.3.0.tar.gz">PHOTOS 3.0 source code </a> tarball.
108 
109  Note that LCG/Genser
110  <a href="http://sftweb.cern.ch/generators/">Generator
111  Services Subproject </a> distributes compiled, platform adopted
112  tar balls of our programs.
113 
114  @section intro Introduction/Status
115 
116  The tar file contains the C++ interface along with parts of
117  the source code for PHOTOS (see <a href="http://wasm.web.cern.ch/wasm/goodies.html">here</a>, version from Oct 11 2005).
118 
119  The tar-ball has the functionality at least of its FORTRAN predecessor for all cases.
120  An extensive number of tests performed in X.2011 and XI.2011 has been collected on the webpage of <a href="http://annapurna.ifj.edu.pl/~wasm/phNLO.htm">photos NLO tests</a>.
121  In particular, tests with SANC went at sub 0.01\% level
122 
123  @section setup Requirements
124 
125  For compilation, and to run the simple example, the interface requires:
126  - <a href="http://lcgapp.cern.ch/project/simu/HepMC/">HepMC v2.04</a> or later.
127 
128  For a multitude of examples, one needs to install the libraries necessary to
129 generate physics events stored in HepMC and to monitor such events:
130  - <a href="http://home.thep.lu.se/~torbjorn/Pythia.html">PYTHIA 8.1</a> or later. PYTHIA must be compiled with HepMC 2 so that the PYTHIA library hepmcinterface exists.
131  - <a href="http://tauolapp.web.cern.ch">TAUOLA C++ Interface v1.0.7</a> or later (we expect Tauolapp namespace to be defined).
132  - <a href="http://mc-tester.web.cern.ch/MC-TESTER/">MC-TESTER v1.24</a> or later. Do not forget to compile the additional HepMC library libHepMCEvent as well.
133  - <a href="http://root.cern.ch/drupal/">ROOT v5.18</a> or later
134 
135  @section compile Configuration and Compilation
136 
137  In order to compile the PHOTOS C++ interface:
138  - Execute './configure' with additional command line options:
139  - '--with-hepmc=<path> ' provides the path to the HepMC installation directory. One can set the HEPMCLOCATION variable instead of using this directive. This path is required for the interface to compile. To compile without HepMC use '--without-hepmc'.
140  - '--prefix=<path>' provides the installation path. The 'include' and 'lib' directories will be copied there if 'make install' is executed later. If none has been provided, the default directory for installation is '/usr/local'.
141  - Execute 'make'
142  - Optionally, execute 'make install' to copy files to the directory provided during configuration.
143 
144  The PHOTOS C++ interface will be compiled and the '/lib' and '/include' directories will contain the appropriate library and include files.
145 
146  In order to compile the examples, enter 'examples' directory, and:
147  - execute './configure' to determine which examples can be compiled. Additional paths can be provided as command line options:
148  - '--with-pythia8=<path>' provides the path to the Pythia8 installation directory. One can set the PYTHIALOCATION variable instead of using this directive. This path is required for all examples and tests.
149  - '--with-mc-tester=<path>' provides the path to the MC-Tester installation directory (the libHepMCEvent must be compiled as well, check the MC-Tester documentation for more details). One can set the MCTESTERLOCATION variable instead of using this directive. This path is required for all additional examples and tests. It is assumed that using this option also implies that ROOT has already been installed (since it's required by MC-TESTER). The location of its binaries should be listed in the PATH variable.
150  - '--with-tauola=<path>' provides the path to the TAUOLA C++ interface installation directory. One can set the TAUOLALOCATION variable instead of using this directive. This path is required for additional examples.
151  - execute 'make'
152 
153  Note that for examples working with PYTHIA 8.1, the PYTHIA8DATA global variable must be set (refer to the instructions provided during configuration).
154  Similarly, for examples in the examples/testing directory to work, the MCTESTERLOCATION global variable must be set.
155  If neither PYTHIA nor MC-TESTER are available, only the simple example can be
156 used. The '/examples' directory will contain the compiled example files.
157 
158  @section testing Testing
159 
160  In order to run more elaborate and physics interesting tests both PYTHIA
161 and MC-TESTER must be installed. In some cases TAUOLA C++ will be needed too.
162  - Compile the PHOTOS C++ interface as well as examples.
163  - Check that the appropriate system variables are set: normally set by the script
164  configure.paths.sh [.csh] (the configuation step mentions this script).
165  - Enter the /examples/testing directory. Modify test.inc if needed.
166  - Enter the selected directory and execute 'make'.
167 
168  The appropriate .root files as well as .pdf files generated by MC-TESTER will be created inside the choosen directory. You can execute 'make clobber' to clean the directory. You can also execute 'make' inside the 'PHOTOS/examples/testing' directory to run all available tests one after another.
169 
170 
171 
172  <hr>
173 Last update; usually last night by the robot, see the doxygen time below and revision info of the development version.
174 
175 */