Description of PHOTOS Interface in C++

License

Authors: Nadia Davidson, Tomasz Przedzinski, Zbigniew Was

This software is available under MIT license. See LICENSE file.

New release

NOTEWe are slowly moving towards CERN GitLab. See: Photospp GitLab page

The source code and documentation for release 3.64. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.64 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

IMPORTANT NOTE: Since release 3.64 we have added HepMC3 support (HepMC3 is avialble on the official HepMC website). We have also adapted examples to Tauola v1.1.8 which means Tauola examples and tests will not compile with Tauola v1.1.6 or older.

Developement version

The source code and documentation are updated daily from the repository. The following files are provided for download of the developement version:

Photos_interface_design.pdf full software documentation.
PHOTOS development version source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt.

Older releases

The source code and documentation for release 3.61. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.61 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.60 (not suitable for EvtGen interface). The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.60 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.56. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.56 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.55. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.55 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.54. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.54 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.52. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.52 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.51. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.51 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.5. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.5 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt

The source code and documentation for release 3.4. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.4 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt
NEW: methods to correct content of event record: (i) mass (ii) add history entries (iii) program is still not ready to work for cases when in vertex some daughters are history and some other are not.

The source code and documentation for release 3.3. The following files are provided for download:

Photos_interface_design.pdf full software documentation.
PHOTOS 3.3 source code tarball ( version for LHC/LCG installation) and its revision info SVN tag, tarball creation date/time, etc. For updates with respect to release 3.0 see changelog.txt
NEW: NLO in decays of Z, W and B (K) –> 2 scalar, photos NLO tests.

The source code and documentation for release 3.0. The following files are provided for download:

arXiv:1011.0937 full software documentation.
PHOTOS 3.0 source code tarball.

Note that LCG/Genser Generator Services Subproject distributes compiled, platform adopted tar balls of our programs.

Introduction/Status

The tar file contains the C++ interface along with parts of the source code for PHOTOS (see here, version from Oct 11 2005).

The tar-ball has the functionality at least of its FORTRAN predecessor for all cases. An extensive number of tests performed in X.2011 and XI.2011 has been collected on the webpage of photos NLO tests. In particular, tests with SANC went at sub 0.01% level

Requirements

For compilation, and to run the simple example, the interface requires:

HepMC v2.04 or later.

For a multitude of examples, one needs to install the libraries necessary to generate physics events stored in HepMC and to monitor such events:

PYTHIA 8.1 or later. PYTHIA must be compiled with HepMC 2 so that the PYTHIA library hepmcinterface exists.
TAUOLA C++ Interface v1.0.7 or later (we expect Tauolapp namespace to be defined).
MC-TESTER v1.24 or later. Do not forget to compile the additional HepMC library libHepMCEvent as well.
ROOT v5.18 or later

Configuration and Compilation

In order to compile the PHOTOS C++ interface:

Execute './configure' with additional command line options:
- '–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'.
- '–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'.
Execute 'make'
Optionally, execute 'make install' to copy files to the directory provided during configuration.

The PHOTOS C++ interface will be compiled and the '/lib' and '/include' directories will contain the appropriate library and include files.

In order to compile the examples, enter 'examples' directory, and:

execute './configure' to determine which examples can be compiled. Additional paths can be provided as command line options:
- '–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.
- '–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.
- '–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.
execute 'make'

Note that for examples working with PYTHIA 8.1, the PYTHIA8DATA global variable must be set (refer to the instructions provided during configuration). Similarly, for examples in the examples/testing directory to work, the MCTESTERLOCATION global variable must be set. If neither PYTHIA nor MC-TESTER are available, only the simple example can be used. The '/examples' directory will contain the compiled example files.

Testing

In order to run more elaborate and physics interesting tests both PYTHIA and MC-TESTER must be installed. In some cases TAUOLA C++ will be needed too.

Compile the PHOTOS C++ interface as well as examples.
Check that the appropriate system variables are set: normally set by the script configure.paths.sh [.csh] (the configuation step mentions this script).
Enter the /examples/testing directory. Modify test.inc if needed.
Enter the selected directory and execute 'make'.

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.

Last update; usually last night by the robot, see the doxygen time below and revision info of the development version.