mainpage.h
1 /**
2 
3  @mainpage C++ Interface to PHOTOS
4  @brief Description of PHOTOS Interface in C++
5 
6  @section License
7 
8  @authors Nadia Davidson, Tomasz Przedzinski, Zbigniew Was
9 
10  This software is available under MIT license. See <a href="resources/LICENSE">LICENSE</a> file.
11 
12  @section download1 New release
13 
14  <b>NOTE</b>We are slowly moving towards CERN GitLab. See: <a href="https://gitlab.cern.ch/photospp/photospp">Photospp GitLab page</a>
15 
16  The source code and documentation for release 3.64. The following files are provided for download:
17  - <a href="resources/PHOTOS.3.64/Photos_interface_design.3.64.pdf">Photos_interface_design.pdf</a> full software documentation.
18  - <a href="resources/PHOTOS.3.64/PHOTOS.3.64.tar.gz">PHOTOS 3.64 source code </a> tarball
19  ( <a href="resources/PHOTOS.3.64/PHOTOS.3.64-LHC.tar.gz"> version for LHC/LCG</a> installation)
20  and its <a href="resources/PHOTOS.3.64/svn_info_photos.3.64.txt">revision info</a> SVN tag, tarball creation date/time, etc.
21  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.64/changelog.3.64.txt">changelog.txt</a>
22 
23  <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>).
24  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>.
25 
26  @section developement Developement version
27 
28  The source code and documentation are updated daily from the repository. The following files are provided for download of the developement version:
29  - <a href="resources/PHOTOS.development.version/Photos_interface_design.development.version.pdf">Photos_interface_design.pdf</a> full software documentation.
30  - <a href="resources/PHOTOS.development.version/PHOTOS.development.version.tar.gz">PHOTOS development version source code </a> tarball
31  ( <a href="resources/PHOTOS.development.version/PHOTOS.development.version-LHC.tar.gz"> version for LHC/LCG</a> installation)
32  and its <a href="resources/PHOTOS.development.version/svn_info_photos.development.version.txt">revision info</a> SVN tag, tarball creation date/time, etc.
33  For updates with respect to release 3.0 see <a href="resources/PHOTOS.development.version/changelog.development.version.txt">changelog.txt</a>.
34 
35  @section download Older releases
36 
37  The source code and documentation for release 3.61. The following files are provided for download:
38  - <a href="resources/PHOTOS.3.61/Photos_interface_design.3.61.pdf">Photos_interface_design.pdf</a> full software documentation.
39  - <a href="resources/PHOTOS.3.61/PHOTOS.3.61.tar.gz">PHOTOS 3.61 source code </a> tarball
40  ( <a href="resources/PHOTOS.3.61/PHOTOS.3.61-LHC.tar.gz"> version for LHC/LCG</a> installation)
41  and its <a href="resources/PHOTOS.3.61/svn_info_photos.3.61.txt">revision info</a> SVN tag, tarball creation date/time, etc.
42  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.61/changelog.3.61.txt">changelog.txt</a>
43 
44  The source code and documentation for release 3.60 (not suitable for EvtGen interface). The following files are provided for download:
45  - <a href="resources/PHOTOS.3.60/Photos_interface_design.3.60.pdf">Photos_interface_design.pdf</a> full software documentation.
46  - <a href="resources/PHOTOS.3.60/PHOTOS.3.60.tar.gz">PHOTOS 3.60 source code </a> tarball
47  ( <a href="resources/PHOTOS.3.60/PHOTOS.3.60-LHC.tar.gz"> version for LHC/LCG</a> installation)
48  and its <a href="resources/PHOTOS.3.60/svn_info_photos.3.60.txt">revision info</a> SVN tag, tarball creation date/time, etc.
49  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.60/changelog.3.60.txt">changelog.txt</a>
50 
51  The source code and documentation for release 3.56. The following files are provided for download:
52  - <a href="resources/PHOTOS.3.56/Photos_interface_design.3.56.pdf">Photos_interface_design.pdf</a> full software documentation.
53  - <a href="resources/PHOTOS.3.56/PHOTOS.3.56.tar.gz">PHOTOS 3.56 source code </a> tarball
54  ( <a href="resources/PHOTOS.3.56/PHOTOS.3.56-LHC.tar.gz"> version for LHC/LCG</a> installation)
55  and its <a href="resources/PHOTOS.3.56/svn_info_photos.3.56.txt">revision info</a> SVN tag, tarball creation date/time, etc.
56  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.56/changelog.3.56.txt">changelog.txt</a>
57 
58  The source code and documentation for release 3.55. The following files are provided for download:
59  - <a href="resources/PHOTOS.3.55/Photos_interface_design.3.55.pdf">Photos_interface_design.pdf</a> full software documentation.
60  - <a href="resources/PHOTOS.3.55/PHOTOS.3.55.tar.gz">PHOTOS 3.55 source code </a> tarball
61  ( <a href="resources/PHOTOS.3.55/PHOTOS.3.55-LHC.tar.gz"> version for LHC/LCG</a> installation)
62  and its <a href="resources/PHOTOS.3.55/svn_info_photos.3.55.txt">revision info</a> SVN tag, tarball creation date/time, etc.
63  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.55/changelog.3.55.txt">changelog.txt</a>
64 
65  The source code and documentation for release 3.54. The following files are provided for download:
66  - <a href="resources/PHOTOS.3.54/Photos_interface_design.3.54.pdf">Photos_interface_design.pdf</a> full software documentation.
67  - <a href="resources/PHOTOS.3.54/PHOTOS.3.54.tar.gz">PHOTOS 3.54 source code </a> tarball
68  ( <a href="resources/PHOTOS.3.54/PHOTOS.3.54-LHC.tar.gz"> version for LHC/LCG</a> installation)
69  and its <a href="resources/PHOTOS.3.54/svn_info_photos.3.54.txt">revision info</a> SVN tag, tarball creation date/time, etc.
70  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.54/changelog.3.54.txt">changelog.txt</a>
71 
72  The source code and documentation for release 3.52. The following files are provided for download:
73  - <a href="resources/PHOTOS.3.52/Photos_interface_design.3.52.pdf">Photos_interface_design.pdf</a> full software documentation.
74  - <a href="resources/PHOTOS.3.52/PHOTOS.3.52.tar.gz">PHOTOS 3.52 source code </a> tarball
75  ( <a href="resources/PHOTOS.3.52/PHOTOS.3.52-LHC.tar.gz"> version for LHC/LCG</a> installation)
76  and its <a href="resources/PHOTOS.3.52/svn_info_photos.3.52.txt">revision info</a> SVN tag, tarball creation date/time, etc.
77  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.52/changelog.3.52.txt">changelog.txt</a>
78 
79  The source code and documentation for release 3.51. The following files are provided for download:
80  - <a href="resources/PHOTOS.3.51/Photos_interface_design.3.51.pdf">Photos_interface_design.pdf</a> full software documentation.
81  - <a href="resources/PHOTOS.3.51/PHOTOS.3.51.tar.gz">PHOTOS 3.51 source code </a> tarball
82  ( <a href="resources/PHOTOS.3.51/PHOTOS.3.51-LHC.tar.gz"> version for LHC/LCG</a> installation)
83  and its <a href="resources/PHOTOS.3.51/svn_info_photos.3.51.txt">revision info</a> SVN tag, tarball creation date/time, etc.
84  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.51/changelog.3.51.txt">changelog.txt</a>
85 
86  The source code and documentation for release 3.5. The following files are provided for download:
87  - <a href="resources/PHOTOS.3.5/Photos_interface_design.3.5.pdf">Photos_interface_design.pdf</a> full software documentation.
88  - <a href="resources/PHOTOS.3.5/PHOTOS.3.5.tar.gz">PHOTOS 3.5 source code </a> tarball
89  ( <a href="resources/PHOTOS.3.5/PHOTOS.3.5-LHC.tar.gz"> version for LHC/LCG</a> installation)
90  and its <a href="resources/PHOTOS.3.5/svn_info_photos.3.5.txt">revision info</a> SVN tag, tarball creation date/time, etc.
91  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.5/changelog.3.5.txt">changelog.txt</a>
92 
93  The source code and documentation for release 3.4. The following files are provided for download:
94  - <a href="resources/PHOTOS.3.4/Photos_interface_design.3.4.pdf">Photos_interface_design.pdf</a> full software documentation.
95  - <a href="resources/PHOTOS.3.4/PHOTOS.3.4.tar.gz">PHOTOS 3.4 source code </a> tarball
96  ( <a href="resources/PHOTOS.3.4/PHOTOS.3.4-LHC.tar.gz"> version for LHC/LCG</a> installation)
97  and its <a href="resources/PHOTOS.3.4/svn_info_photos.3.4.txt">revision info</a> SVN tag, tarball creation date/time, etc.
98  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.4/changelog.3.4.txt">changelog.txt</a>
99  - NEW: methods to correct content of event record: (i) mass (ii) add history entries (iii) program is still not ready to work
100  for cases when in vertex some daughters are history and some other are not.
101 
102  The source code and documentation for release 3.3. The following files are provided for download:
103  - <a href="resources/PHOTOS.3.3/Photos_interface_design.3.3.pdf">Photos_interface_design.pdf</a> full software documentation.
104  - <a href="resources/PHOTOS.3.3/PHOTOS.3.3.tar.gz">PHOTOS 3.3 source code </a> tarball
105  ( <a href="resources/PHOTOS.3.3/PHOTOS.3.3-LHC.tar.gz"> version for LHC/LCG</a> installation)
106  and its <a href="resources/PHOTOS.3.3/svn_info_photos.3.3.txt">revision info</a> SVN tag, tarball creation date/time, etc.
107  For updates with respect to release 3.0 see <a href="resources/PHOTOS.3.3/changelog.3.3.txt">changelog.txt</a>
108  - 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>.
109 
110 
111  The source code and documentation for release 3.0. The following files are provided for download:
112  - <a href="http://arxiv.org/abs/1011.0937">arXiv:1011.0937</a> full software documentation.
113  - <a href="resources/PHOTOS.3.0.tar.gz">PHOTOS 3.0 source code </a> tarball.
114 
115  Note that LCG/Genser
116  <a href="http://sftweb.cern.ch/generators/">Generator
117  Services Subproject </a> distributes compiled, platform adopted
118  tar balls of our programs.
119 
120  @section intro Introduction/Status
121 
122  The tar file contains the C++ interface along with parts of
123  the source code for PHOTOS (see <a href="http://wasm.web.cern.ch/wasm/goodies.html">here</a>, version from Oct 11 2005).
124 
125  The tar-ball has the functionality at least of its FORTRAN predecessor for all cases.
126  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>.
127  In particular, tests with SANC went at sub 0.01\% level
128 
129  @section setup Requirements
130 
131  For compilation, and to run the simple example, the interface requires:
132  - <a href="http://lcgapp.cern.ch/project/simu/HepMC/">HepMC v2.04</a> or later.
133 
134  For a multitude of examples, one needs to install the libraries necessary to
135 generate physics events stored in HepMC and to monitor such events:
136  - <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.
137  - <a href="http://tauolapp.web.cern.ch">TAUOLA C++ Interface v1.0.7</a> or later (we expect Tauolapp namespace to be defined).
138  - <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.
139  - <a href="http://root.cern.ch/drupal/">ROOT v5.18</a> or later
140 
141  @section compile Configuration and Compilation
142 
143  In order to compile the PHOTOS C++ interface:
144  - Execute './configure' with additional command line options:
145  - '--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'.
146  - '--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'.
147  - Execute 'make'
148  - Optionally, execute 'make install' to copy files to the directory provided during configuration.
149 
150  The PHOTOS C++ interface will be compiled and the '/lib' and '/include' directories will contain the appropriate library and include files.
151 
152  In order to compile the examples, enter 'examples' directory, and:
153  - execute './configure' to determine which examples can be compiled. Additional paths can be provided as command line options:
154  - '--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.
155  - '--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.
156  - '--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.
157  - execute 'make'
158 
159  Note that for examples working with PYTHIA 8.1, the PYTHIA8DATA global variable must be set (refer to the instructions provided during configuration).
160  Similarly, for examples in the examples/testing directory to work, the MCTESTERLOCATION global variable must be set.
161  If neither PYTHIA nor MC-TESTER are available, only the simple example can be
162 used. The '/examples' directory will contain the compiled example files.
163 
164  @section testing Testing
165 
166  In order to run more elaborate and physics interesting tests both PYTHIA
167 and MC-TESTER must be installed. In some cases TAUOLA C++ will be needed too.
168  - Compile the PHOTOS C++ interface as well as examples.
169  - Check that the appropriate system variables are set: normally set by the script
170  configure.paths.sh [.csh] (the configuation step mentions this script).
171  - Enter the /examples/testing directory. Modify test.inc if needed.
172  - Enter the selected directory and execute 'make'.
173 
174  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.
175 
176 
177 
178  <hr>
179 Last update; usually last night by the robot, see the doxygen time below and revision info of the development version.
180 
181 */