diff --git a/AUTHORS b/AUTHORS --- a/AUTHORS +++ b/AUTHORS @@ -1,99 +1,99 @@ Original package authors: -David Lange -Anders Ryd +* David Lange +* Anders Ryd Current authors / maintainers: -John Back -Michal Kreps -Thomas Latham +* John Back +* Michal Kreps +* Thomas Latham Contributors: -Abi Soffer -Adlene Hicheur -Ajit Kurup -Akimasa Ishikawa -Aleksandr Berezhnoi -Aleksei Luchinsky -Alexander Popov -Alexei Dvoretskii -Alexei Volk -Anatoli Likhoded -Andrei Gritsan -Andrew Crocombe -Andrii Verbytskyi -Anna Danilina -Aurelien Martens -Bob Cahn -Brian Hamilton -Christoph Langenbruch -Clara Remon -Daniel Craik -David Cote -David Grellscheid -David Kirkby -David Loh -Denis Dujmic -Diego Martinez Santos -Edward Chen -Elisabeth Niel -Eric Conte -Fernando Martinez-Vidal -Florence Ranjard -Francesca Di Lodovico -Francesco Sandrelli -Frank Wuerthwein -Frederic Dreyer -Gerhard Raven -Gloria Corti -Greig Cowan -Jack Wimberley -Jan Strube -Jane Tinslay -Jeff Berryhill -Jeremy Dalseno -Jim Hunt -Jim Libby -Jochen Dingfelder -Joe Izen -Jordi Garra Tico -Josh Thompson -Karen Gibson -Konstantin Toms -Liaoyuan Dong -Luis Miguel Garcia Martin -Marcello Rotondo -Marcin Chrzaszcz -Marco Bomben -Marco Gersabeck -Marcos Romero Lamas -Mark Smith -Mark Whitehead -Mark Ian Williams -Martin Simard -Matt Graham -Maurizio Pierini -Max Baak -Michael Sigamani -Natalia Kuznetsova -Nick Brook -Nikolai Nikitin -Patrick Robbe -Pavel Reznicek -Peter Richardson -Phil Strother -Ricardo Faccini -Richard Tesarek -Romulus Godang -Ryan Newcombe -Sheila McLachlin -Simon Patton -Sophie Versille -Stephane Willocq -Steve Sekula -Sven Menke -Thomas Blake -Tomas Pilar -Veronika Chobanova -Wells Wulsin -Will Reece -William Sutcliffe +* Abi Soffer +* Adlene Hicheur +* Ajit Kurup +* Akimasa Ishikawa +* Aleksandr Berezhnoi +* Aleksei Luchinsky +* Alexander Popov +* Alexei Dvoretskii +* Alexei Volk +* Anatoli Likhoded +* Andrei Gritsan +* Andrew Crocombe +* Andrii Verbytskyi +* Anna Danilina +* Aurelien Martens +* Bob Cahn +* Brian Hamilton +* Christoph Langenbruch +* Clara Remon +* Daniel Craik +* David Cote +* David Grellscheid +* David Kirkby +* David Loh +* Denis Dujmic +* Diego Martinez Santos +* Edward Chen +* Elisabeth Niel +* Eric Conte +* Fernando Martinez-Vidal +* Florence Ranjard +* Francesca Di Lodovico +* Francesco Sandrelli +* Frank Wuerthwein +* Frederic Dreyer +* Gerhard Raven +* Gloria Corti +* Greig Cowan +* Jack Wimberley +* Jan Strube +* Jane Tinslay +* Jeff Berryhill +* Jeremy Dalseno +* Jim Hunt +* Jim Libby +* Jochen Dingfelder +* Joe Izen +* Jordi Garra Tico +* Josh Thompson +* Karen Gibson +* Konstantin Toms +* Liaoyuan Dong +* Luis Miguel Garcia Martin +* Marcello Rotondo +* Marcin Chrzaszcz +* Marco Bomben +* Marco Gersabeck +* Marcos Romero Lamas +* Mark Smith +* Mark Whitehead +* Mark Ian Williams +* Martin Simard +* Matt Graham +* Maurizio Pierini +* Max Baak +* Michael Sigamani +* Natalia Kuznetsova +* Nick Brook +* Nikolai Nikitin +* Patrick Robbe +* Pavel Reznicek +* Peter Richardson +* Phil Strother +* Ricardo Faccini +* Richard Tesarek +* Romulus Godang +* Ryan Newcombe +* Sheila McLachlin +* Simon Patton +* Sophie Versille +* Stephane Willocq +* Steve Sekula +* Sven Menke +* Thomas Blake +* Tomas Pilar +* Veronika Chobanova +* Wells Wulsin +* Will Reece +* William Sutcliffe diff --git a/CMakeLists.txt b/CMakeLists.txt --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -89,15 +89,20 @@ configure_file(DECAY_2010.XML ${CMAKE_CURRENT_BINARY_DIR}/DECAY_2010.XML COPYONLY) # Build the executables in the test and validation directories -option(EVTGEN_BUILD_DOC "Enable/disable building of documentation in 'doc' directory" OFF) -option(EVTGEN_BUILD_TESTS "Enable/disable building of executables in 'test' directory" OFF) -option(EVTGEN_BUILD_VALIDATIONS "Enable/disable building of executables in 'validation' directory" OFF) -message(STATUS "EvtGen: Building of documentation in 'doc' directory EVTGEN_BUILD_DOC ${EVTGEN_BUILD_DOC}") -message(STATUS "EvtGen: Building of executables in 'test' directory EVTGEN_BUILD_TESTS ${EVTGEN_BUILD_TESTS}") -message(STATUS "EvtGen: Building of executables in 'validation' directory EVTGEN_BUILD_VALIDATIONS ${EVTGEN_BUILD_VALIDATIONS}") +option(EVTGEN_BUILD_DOC "Enable/disable building of userguide documentation in 'doc' directory" OFF) +option(EVTGEN_BUILD_DOXYGEN "Enable/disable building of Doxygen documentation in 'doxygen' directory" OFF) +option(EVTGEN_BUILD_TESTS "Enable/disable building of executables in 'test' directory" OFF) +option(EVTGEN_BUILD_VALIDATIONS "Enable/disable building of executables in 'validation' directory" OFF) +message(STATUS "EvtGen: Building of userguide documentation in 'doc' directory EVTGEN_BUILD_DOC ${EVTGEN_BUILD_DOC}") +message(STATUS "EvtGen: Building of Doxygen documentation in 'doxygen' directory EVTGEN_BUILD_DOXYGEN ${EVTGEN_BUILD_DOXYGEN}") +message(STATUS "EvtGen: Building of executables in 'test' directory EVTGEN_BUILD_TESTS ${EVTGEN_BUILD_TESTS}") +message(STATUS "EvtGen: Building of executables in 'validation' directory EVTGEN_BUILD_VALIDATIONS ${EVTGEN_BUILD_VALIDATIONS}") if(EVTGEN_BUILD_DOC) add_subdirectory(doc) endif() +if(EVTGEN_BUILD_DOXYGEN) + add_subdirectory(doxygen) +endif() if(EVTGEN_BUILD_TESTS) add_subdirectory(test) endif() @@ -112,18 +117,24 @@ install(DIRECTORY EvtGenModels DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) # Install the particle properties and decay tables -install(FILES DECAY.DEC DECAY.XML evt.pdl DECAY_2010.XML DECAY_2010.DEC DECAY_2009.XML DECAY_2009.DEC DESTINATION ${CMAKE_INSTALL_DATADIR}/EvtGen) +install(FILES DECAY.DEC DECAY.XML evt.pdl DECAY_2010.XML DECAY_2010.DEC DECAY_2009.XML DECAY_2009.DEC DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}) + +# Install the COPYING and AUTHORS files +install(FILES AUTHORS COPYING DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}) + +# Install the README and History files +install(FILES README.md Pythia8_README.md Tauola_README.md History.md DESTINATION ${CMAKE_INSTALL_DOCDIR}/${CMAKE_PROJET_NAME}) # Generate CMake config files, which can be used by other projects include(CMakePackageConfigHelpers) set(INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}) set(LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}) -set(DATA_INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/EvtGen) +set(DATA_INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}) configure_package_config_file(cmake/Templates/EvtGenConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/EvtGenConfig.cmake - INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/EvtGen/cmake + INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}/cmake PATH_VARS INCLUDE_INSTALL_DIR LIB_INSTALL_DIR DATA_INSTALL_DIR ) @@ -133,11 +144,11 @@ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/EvtGenConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/EvtGenConfigVersion.cmake - DESTINATION ${CMAKE_INSTALL_DATADIR}/EvtGen/cmake + DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}/cmake ) install( EXPORT "EvtGenTargets" NAMESPACE "EvtGen::" - DESTINATION ${CMAKE_INSTALL_DATADIR}/EvtGen/cmake + DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJET_NAME}/cmake ) diff --git a/History.md b/History.md new file mode 100644 --- /dev/null +++ b/History.md @@ -0,0 +1,697 @@ +# History file for EvtGen + +From version 2.0.0, +Tabc labels refer to [Maniphest tasks](https://phab.hepforge.org/maniphest/query/nkBRd9OhPCBN/), while +Dxyz labels refer to [Differential code reviews](https://phab.hepforge.org/differential/query/YDY8EgjNGd.e/) on HepForge: + +https://phab.hepforge.org/Tabc + +https://phab.hepforge.org/Dxyz + +21st Aug 2020 John Back +* T109: Add EvtEtaLLPiPi model for eta' -> l l pi pi decays (l = e or mu), + - courtesy of Aleksei Luchinsky (LHCb). + +29th Jun 2020 Michal Kreps +* T103: Add missing include in EvtGenBase/EvtMatrix.hh. + +15th May 2020 Michal Kreps +* D28: Add EvtThreeBodyPhsp (rectangular Dalitz plot selection) and + EvtPhspDecaytimeCut (minimum decay time requirement) models. +* D27: Fix initialisation of constants in EvtBTo3hCP model. + +=== +## R02-00-00 + +24th Apr 2020 Michal Kreps +* Update particle properties file evt.pdl to 2019 version of RPP by PDG. + +23rd Apr 2020 Tom Latham +* Apply copyright and licence notices to all relevant files. + +17th Apr 2020 Tom Latham +* Add text of GNU GPLv3 in COPYING, add (preliminary) list of authors in + AUTHORS, and clean-up all source files, prior to applying copyright and + licence notices. + +9th Apr 2020 Tom Latham +* Improve, and document use of, standalone installation script. +* Apply clang-format formatting to all C++ source files. + +8th Apr 2020 Tom Latham +* One small modernisation change to EvtPhotosEngine to match that already + applied in EvtTauolaEngine. + +8th Apr 2020 John Back +* Fixed NonReson amplitude and the 4-momentum boosts used for angles in + EvtLambdacPHH, + - courtesy of Elisabeth Niel (LHCb). + +7th Apr 2020 Gerhard Raven, Tom Latham, Michal Kreps and John Back +* Incorporate C++ modernization changes from Gerhard Raven (LHCb). + - Merged modernize branch into master. + +9th Mar 2020 John Back +* Add EvtAbsExternalGen::getDecayProb() to allow external generators to + return a probability that can be used in EvtDecayProb (default = 1). + +6th Mar 2020 Andrii Verbytskyi and Tom Latham +* Implement HepMC3 support: EvtHepMCEvent, external engines & cmake files. + +15th Nov 2019 John Back +* Added EvtPsi2JpsiPiPi model for psi2S -> J/psi pi+ pi- decays based on hep-ph/1507.07985, + - courtesy of Aleksei Luchinsky (LHCb). + +21st August 2019 Michal Kreps +* Added the EvtDToKpienu decay model for D -> K pi e nu decays from BESIII, + - courtesy of Liaoyuan Dong. + +16th July 2019 John Back +* Correct imaginary sign for EvtComplex /= (EvtComplex c) operator. + +3rd July 2019 John Back +* Added the EvtLambdacPHH decay model for Lc -> p K pi decays with K*(890), + Delta++(1232) and Lambda(1520) resonances, based on the Fermilab E791 + analysis hep-ex/9912003v1, + - courtesy of Elisabeth Niel and Patrick Robbe (LHCb). +* Modified EvtResonance2 to accept other barrier factor radii. + +3rd July 2019 Michal Kreps +* Make sure minimum mass for resonances with non-zero widths is larger than + 1e-4 GeV in EvtRelBreitWignerBarrierFact. + +3rd May 2019 John Back +* Corrected EvtSLDiBaryonAmp bugs/issues in the BToDiBaryonlnupQCD model: + - parity, amplitude terms and B momentum reference frame variables. +* Corrected treament of spinor indices in EvtRareLb2Lll, + - courtesy of Tom Blake and Michal Kreps (LHCb). +* Updated the EvtBcVHad model to also handle Bc -> psi Ks K decays, + - courtesy of Aleksei Luchinsky (LHCb). +* Add new decay model EvtBsMuMuKK (BS_MUMUKK) for Bs to J/psi (mu+mu-) K+K-, + - courtesy of Veronika Chobanova, Jeremy Dalseno, Diego Martinez Santos and + Marcos Romero Lamas (LHCb). +* Fix infinite loop during initialisation of the EvtBTo3hCP model via + EvtCBTo3piP00 and EvtCBTo3piMPP, + - courtesy of Peter Richardson (Durham). + +15th March 2019 Tom Latham +* Implement cmake build system, replacing the old config method. + +30th Jan 2019 John Back +* Fix modernization compiler errors and warnings. + +29th Jan 2019 Michal Kreps +* Allow reading decay files which are missing end-of-line before end-of-file. + +21st December 2018 John Back +* Imported C++ modernization changes from Gerhard Raven (LHCb). + +7th December 2018 John Back +* Added the EvtBLLNuL (BLLNUL) model that generates rare B -> ell ell nu ell + decays, where ell = e or mu, + - courtesy of Anna Danilina and Nikolai Nikitin (LHCb). +* Removed the EvtB2MuMuMuNu (BUTOMMMN) model, since its now replaced + by the more general BLLNuL one. + +5th November 2018 John Back +* Added the BToDiBaryonlnupQCD model for generating B to p N* l nu decays, + where N can be any (exited) charged baryon (spin 1/2 or 3/2), + - courtesy of Mark Smith and Ryan Newcombe (LHCb), with added code optimisations. + +17th October 2018 John Back +* Added various decay models from LHCb EvtGenExtras package: + - EvtBcVHad ("BC_VHAD"), + - Evtbs2llGammaMNT ("BSTOGLLMNT"), + - Evtbs2llGammaISRFSR ("BSTOGLLISRFSR"), + - EvtbTosllMS ("BTOSLLMS"), + - EvtbTosllMSExt ("BTOSLLMSEXT"), + - EvtLb2Baryonlnu ("Lb2Baryonlnu"), + - EvtLb2plnuLCSR ("Lb2plnuLCSR"), + - EvtLb2plnuLQCD ("Lb2plnuLQCD"), + - EvtFlatSqDalitz ("FLATSQDALITZ"), + - EvtPhspFlatLifetime ("PHSPFLATLIFETIME"). + +5th October 2018 John Back +* Updated setupEvtGen.sh to work with the new HepForge Phabricator site. + +13th March 2018 John Back +* Updated EvtPythiaEngine to correctly handle updates of various particle + properties so that Pythia uses the same information as EvtGen (evt.pdl) + for the generic and alias PYTHIA decay model. + +12th March 2018 John Back +* Updated EvtBcXMuNu models (X = Scalar, Vector, Tensor) to generate + Bc to D0(star) mu nu decays, with associated form factors in EvtBCXFF, + - courtesy of Aleksei Luchinsky (LHCb). +* Also generalised the calculation + of their maximum probabilities by reusing the CalcMaxProb method in + EvtSemiLeptonicAmp, which now allows for different Q^2 binning + (default remains at 25 bins). + +=== +## R01-07-00 + +13th December 2017 John Back +* New tag incorporating all changes below. +* Recommended external packages are + (as used in the setupEvtGen.sh script): + - HepMC 2.06.09, + - pythia 8.230, + - Photos++ 3.61 + - Tauola++ 1.1.6c. + +12th December 2017 John Back +* Changed Pythia validation example decay files to use Pythia8 codes. + +6th December 2017 John Back +* Modified the examples to use DECAY.DEC (see 25th April 2016) instead of + DECAY_2010.DEC. Changed EvtExternalGenList to assume Pythia8 codes are + used in decay files by default, which is the case for DECAY.DEC. Also + updated the setupEvtGen.sh script to work with Pythia 8.2x versions. + +29th November 2017 John Back +* Modified EvtSVP, EvtVVP and EvtTVP models to handle both radiative and + two-lepton decays, + - courtesy of Aleksei Luchinsky (LHCb). + +14th July 2017 John Back +* Only create external generator objects if they don't already exist in + EvtExternalGenFactory. +* Modified configure script to work with Pythia 8.2x + +5th July 2017 Michal Kreps +* Register the VTOSLL model. + +14th June 2017 John Back +* Add isNeutralKaon() boolean function and corrected comments in EvtDDalitz. + +8th May 2017 Michal Kreps +* Fix bug in EvtbTosllVectorAmp to recognise Bs --> K*bar mu mu decay as + b --> d ll transition. + +8th May 2017 Michal Kreps +* Significantly simplify way how we decide on decay mode and daughters + ordering in DDalitz model. + - With new code by definition all orderings of + daughters in the decay file will yield same output. + +4th May 2017 John Back +* Further fixes to DDalitz particle ordering (including charge-conjugates): + - Mode 5: D0 -> K- K0bar K+ and K+ K- K0bar + - Mode 12: D0 -> pi0 pi- pi+ and pi+ pi0 pi- + - Removed unneeded index ordering checks for mode 10 (D+ -> pi- pi+ pi+) + and mode 11 (Ds+ -> pi- pi+ pi+) + +27th April 2017 John Back +* Fixed DDalitz particle ordering for mode 7: D+ -> pi+ K- K+ and K+ pi+ K- + and their charge-conjugates + +7th April 2017 John Back +* Modified EvtGenExternal/EvtPythiaEngine to ensure that the EvtGen-based + instances of Pythia8 (for generic and alias decays) use the same + particle properties as defined by EvtGen, + - courtesy Patrick Robbe (LHCb). + +5th April 2017 Michal Kreps +* Fixed indexing in copy constructor of Evt3Rank3C, which would otherwise + produce an infinite loop; + - bug report from David Grellscheid. + +3rd November 2016 John Back +* Modified EvtFlatQ2 model to work for all B -> X lepton lepton modes, as + well as adding an extra phase space factor to correct for the dip at low + q^2, which is enabled by using "FLATQ2 1" instead of just "FLATQ2" in the decay file, + - courtesy of Marcin Chrzaszcz & Thomas Blake (LHCb). + + +13th October 2016 John Back +* Added the TauolaCurrentOption decfile keyword to select the hadronic + current in Tauola; default is the BaBar-tuned current option (int = 1). +* EvtParticles can store double attributes using the functions + setAttributeDouble(name, double) and getAttributeDouble(name), which can + be useful for storing and retrieving amplitude weights, for example. + - The analogous EvtParticle integer attribute interface remains unchanged: + setAttribute(name, int) and getAttribute(name). + +13th September 2016 John Back +* Modified EvtTauolaEngine to use internal Tauola spin matrices for + tau pair events by temporarily setting the PDG id of the mother as a + boson, keeping the same 4-momentum. +* The BaBar hadronic currents are now used by default. +* Also added the ability to change some Tauola parameters + using the "Define" keyword in decay files. +* Added an example decay file + illustrating the new features: validation/TauolaFiles/Btautau.dec + +9th September 2016 Michal Kreps +* Reimplement code in EvtBTo3pi.F, EvtBTo3piMPP.F, EvtBTo3piP00.F and + EvtBToKpipi.F in C++ in order to remove dependence on Fortran compiler. + - With this, there is no internal Fortran code in EvtGen. + +=== +## R01-06-00 + +1st June 2016 John Back +* New tag incorporating all changes below. +* Recommended external packages are + - HepMC 2.06.09 + - pythia 8.186 + - Photos++ 3.61 + - Tauola++ 1.1.5 + +28th April 2016 Michal Kreps +* For Ds+ --> 2pi+ pi- there was double counting of branching fraction + resulting in total branching fraction being 1.5 times larger than measured + one. + - Fix by revisiting submodes, which now fill total Ds --> 3pi. + +25th April 2016 Michal Kreps +* Added DECAY.DEC/XML, which contain updated semileptonic charm and beauty + branching fractions using the 2014 PDG, tuned to minimize disagreements + between measurements and EvtGen for both inclusive and exclusive decays. +* Updated the evt.pdl particle properties file to the PDG 2014 edition. +* Implemented new LQCD form factors for Lb --> L mu mu from arXiv paper + 1602.01399 (EvtRareLbToLllFFlQCD); old LQCD form factors are removed. + +18th March 2016 John Back +* Fixed incorrect spinor algebra used in S1 -> 1/2 S2, 1/2 -> S3 S4 decays + in EvtDiracParticle::rotateToHelicityBasis() functions, + - courtesy of Luis Miguel Garcia Martin and the IFIC Valencia LHCb group. + +19th Feburary 2016 John Back +* Fixed bug in the definition of the initial spinor term Sinit in + EvtRareLbToLll::HadronicAmpRS(), + - from Tom Blake (LHCb). + +12th February 2016 John Back +* From LHCb, added extensions to the EvtHQET2(FF) model for semitauonic + decays from Brian Hamilton, which needs a patch to EvtSemiLeptonicAmp + from Jack Wimberley to ensure that the q^2 range is physical when + finding the maximum amplitude probability. + +2nd December 2015 John Back +* From LHCb, added EvtKStopizmumu model for KS -> pi0 mu mu decays based on + JHEP08(1998)004, + - courtesy of Veronika Chobanova, Diego Martinez Santos and Jeremy Dalseno. +* Added EvtConst::Fermi for Fermi coupling constant. + +=== +## R01-05-00 + +21st October 2015 John Back +* New tag incorporating all changes below. +* Recommended external packages are + - HepMC 2.06.09 + - pythia 8.186 + - Photos++ 3.61 + - Tauola++ 1.1.5 + +* Added the EvtB2MuMuMuNu model for simulating the very rare four-leptonic + decays B- -> mu+ mu- anti-nu_mu mu-, + - courtesy Nikolai Nikitin. + +16th October 2015 John Back +* Updated the configure script to automatically select the library names + for PHOTOS++; version 3.56 and below uses Fortran, version 3.61 and above + uses C++ only (default). Avoid using v3.60, since it does not work. + This needs the PHOTOS libraries built before EvtGen is configured. + Modified setupEvtGen.sh to use Photos++ v3.61. + +7th October 2015 John Back +* Updated EvtGenExternal/EvtPhotosEngine to check that additional particles + from the outgoing vertex are indeed (FSR) photons, since later versions of + PHOTOS introduce pair emission, where particles may not always be photons. +* Added the genRootDecayChain.cc validation program to create ROOT files + containing information about the complete decay tree. Two example test + decay files BKstarGamma.dec and BuDst0rhop.dec can be used with this; the + first tests PHOTOS, the second looks at sequential decay chain storage. + The plotBKstarGamma.C ROOT macro can be used for B -> K* gamma plots. + +2nd October 2015 John Back +* Modified EvtSVPHelAmp and added a new EvtSVPHelCPMix model, implementing + the complete mixing phenomenology of Bs to vector gamma decays, + - courtesy of Clara Remon (LHCb). +* EvtD0mixDalitz code: cleanup, inverted q/p for decays of D0bar (simplifies + user decay files) and fixed y parameter bug, + - courtesy of Jordi Tico (LHCb). +* Changed the initialisation order of the infrared cut-off in EvtPhotosEngine. + This actually has no effect, since the exponentiation function sets it to the + same 1e-7 value, but it is now in the correct order if we need to update it. +* Removed all remaining obsolete pragma (Win32) warnings from some classes. + +23rd September 2015 Michal Kreps +* Reimplement the real Spence function in C++ and removed its fortran + implementation. + +15th September 2015 Michal Kreps +* Fixed accessed uninitialised memory in EvtPDL.cpp, line 213. +* Modified the configure and setupEvtGen.sh scripts to work on Mac; needed + Mac compilation patch files added to the new "platform" subdirectory. + +10th September 2015 John Back +* Updated setupEvtGen.sh to use the recommended external packages: + - HepMC 2.06.09, pythia 8.186, Photos++ 3.56 and Tauola++ 1.1.5. +* Fixed form-factor calculations for the BTOSLLBALL model 6 used to generate + b -> sll decays, + - courtesy of Christoph Langenbruch and David Loh (LHCb). + - Affects B->K*ll, B->rholl and B->omegall, particularly the electron modes. +* In the validation directory, added runPhotosTest.sh for testing FSR in + Upsilon(4S) -> e+ e- decays, and changed the plot comparison scripts to + use the 2nd directory "oldRootFiles" (which could be a soft-link) for + including ROOT histograms made from a previous version of EvtGen. + +27th August 2015 John Back +* Added Mersenne-Twister random number generator (RNG) EvtMTRandomEngine. + - It requires c++11 compiler features (>= gcc 4.7), which should + automatically be enabled by the configure script. + - Introduced the preprocessor environment variable EVTGEN_CPP11 for c++11 + features. + - EvtMTRandomEngine is the default RNG for the validation and test examples + if c++11 features are enabled. +* Added a phase-space test validation/genPHSP.sh and PhaseSpacePlots.C to + visually check the flatness of Dalitz plots in order to ensure that the + RNG is not producing biased results that depend on particle ordering. +* Added the models EvtbsToLLLLAmp and EvtbsToLLLLHyperCP for + B0_q -> l+ l- l+ l- decays (SM and one supersymmetric scenario), + - courtesy of Nikolai Nikitin and Konstantin Toms. + - Documentation provided in doc/evt_BQTOLLLL_model.pdf and + doc/evt_BQTOLLLLHYPERCP_model.pdf. + +* Changed the installation and set-up script name to be just setupEvtGen.sh; + it uses the VERSION variable to specify the required tag. List of tags + are available using either "svn ls -v http://svn.cern.ch/guest/evtgen/tags" + or by going to http://svn.cern.ch/guest/evtgen/tags in a web browser. + +12th June 2015 John Back +* Changed the width of chi_b1 in evt.pdl from 9.8928 GeV (!) to zero. + +1st May 2015 John Back +* Added Bc -> scalar ell nu (EvtBcSMuNu) and Bc -> tensor ell nu + (EvtBcTMuNu) decays, + - courtesy of Jack Wimberley, LHCb. + - Also included the chi_c1 mode for EvtBcVMuNu. + +=== +## R01-04-00 + +2nd April 2015 John Back +* Removed the EvtStdlibRandomEngine class since this can produce biases + to kinematic distributions when one or more of the daughters is a + resonance, such as B0 -> K pi psi + - (thanks to Antonio Augusto Alves Jr who discovered this issue). + - EvtSimpleRandomEngine is now the default random number generator in the + validation and test examples. +* Incorporated several additions and modifications from LHCb: + a) From Michal Kreps, Tom Blake & Christoph Langenbruch, + added rare Lb --> Lambda^(*) ell ell models described in + arXiv:1108.6129, with various form factors from Gutsche et al. + (arXiv:1301.3737) and lattice QCD (arXiv:1212.4827) + b) From Andrew Crocombe, implemented Bs --> K* form factors + from Ball-Zwicky and z-parametrization form factors from + arXiv:1006.4945 for EvtbTosllBallFF + c) Christoph Langenbruch fixed the Bs -> phi ll form factors in + EvtbTosllBallFF; T3 showed a non-physical pole at very low + q2 which significantly affected the electron mode + d) From Michal Kreps, removed semicolons from wrong places to + clear warnings when compiled with the "-pedantic" option. + +9th October 2014 John Back +* Change svnweb.cern.ch to svn.cern.ch in the setup script. + +1st April 2014 John Back +* In EvtReport, modified the logging output severity status flags + to have the "EVTGEN_" prefix, e.g. INFO becomes EVTGEN_INFO. +* The global report() function has been renamed to EvtGenReport(). + +31st March 2014 John Back +* Added the ability to store named attributes for EvtParticles in the + form of a map. The setAttribute(name, value) stores the + required value, while getAttribute(name) retrieves the integer value. + This is used in EvtPhotosEngine to specify the final-state radiation + "FSR" attribute to 1 for any additional photons (EvtPhotonParticles) + created by Photos++. It also stores the "ISR" attribute, but this + is always set to zero, since only FSR photons are created. + If the named attribute does not exist, then getAttribute() returns zero. + +29th January 2014 Daniel Craik +* Removed mass assertion on GS shape in EvtDalitzReso to allow it to also + be used for charged rho resonances. + +27th January 2014 John Back +* Minor corrections to Vub models to remove further gcc 4.8 warnings. +* Updated configure script to work for MacOS clang (from Genser team). + +=== +## R01-03-00 + +9th January 2014 John Back +* New tag version "1.3.0", incorporating all changes below. +* Replaced auto-install script to work with this version as well as + the latest versions of all external generator packages. +* Updated README to mention the new CERN-based web pages for Photos++ + and Tauola++. + +8th January 2014 John Back +* Fix gcc 4.6 and 4.8 compilation warnings, + - courtesy of Patrick Robbe (LHCb); + - main changes are removal of unused variables. +* Changed the EvtPythiaEngine class and configure script to use new + Pythia 8 header locations; Pythia 8.180 or above is now required. + +7th January 2014 John Back +* Modified EvtBCVFF to correct the Kiselev form factors + - from Jack Wimberley (LHCb). + +9th October 2013 Daniel Craik +* Added Gounaris-Sakurai and Gaussian shapes to EvtGenericDalitz + and set sensible defaults for LASS parameters. + +19th September 2013 John Back +* Modified EvtGenExternal/EvtPythiaEngine to keep track of any new + particles that are added to the default Pythia database to avoid + duplicating particle/anti-particle entries that could override + previously defined Pythia decay chains. + +18th September 2013 John Back +* Added Mac OS flags for the configure script and src/Makefile. + +15th July 2013 Daniel Craik +* Added flag to turn on scaling of LASS amplitude by M/q in EvtDalitzReso + +15th July 2013 Daniel Craik +* EvtParserXML now accepts file names containing environment variables, + exponential non-resonant shape in EvtDalitzReso now defined as exp(-alpha*m^2), + LASS shape in EvtDalitzReso now takes a cutoff parameter + +4th July 2013 Daniel Craik +* Added LASS, exponential non-resonant and linear non-resonant shapes to EvtGenericDalitz. + +3rd July 2013 Daniel Craik +* Fixed auto-install script for R01-02-00. + +1st July 2013 Daniel Craik +* Added auto-install script for R01-02-00. + +=== +## R01-02-00 + +15th May 2013 John Back +* New tag, version "1.2.0", incorporating all changes below. + +14th May 2013 Michal Kreps +* Added Blatt-Weisskopf barrier factors up to L=5 in + EvtGenBase/EvtBlattWeisskopf::compute(). + +14th May 2013 John Back +* Added additional entries (appended at the end) to the evt.pdl particle + data file + - courtesy of Romulus Godang and Belle II colleagues. + +14th March 2013 John Back +* Added the method EvtParticle::getPDGId() to get the PDG integer for a + particle directly (which just calls EvtPDL::getStdHep()). +* Added a check in EvtPhotosEngine::doDecay to skip Photos if a given + particle has too many daughters (>= 10) to avoid a problem with a + hard coded upper limit in the Photos PHOENE subroutine. + +2nd February 2013 Daniel Craik +* Updated EvtDalitzTable to estimate probMax when it is missing from a + Dalitz model. + +1st February 2013 John Back +* Added the ability to read in Pythia 6 commands in ascii decay files in + EvtDecayTable::readDecayFile (this was already possible in xml files). +* Modified the Photos++ engine default settings to be more suited to B + decays (from LHCb defaults). + +31st January 2013 John Back +* Added the ability to read in Pythia 8 commands in ascii decay files + in EvtDecayTable::readDecayFile. They can be set using the syntax: + "PythiaTypeParam module:variable=value", where Type = Generic, Alias or + Both for specifying whether the parameter is for the generic or alias + Pythia decay engines (or both). The 2nd argument must not contain any + spaces. Fixed the list of commands strings being used in the + EvtPythiaEngine class (i.e. Pythia parameters that can be set via decay + files). + +31st January 2013 Daniel Craik +* Added named parameters to various decay models. + +30th January 2013 John Back +* Fixed some of the parameter arguments used in the EvtSVSCPiso model. + +24th January 2013 John Back +* Set the Photos++ and Tauola++ models to use the EvtGen random number + engine when useEvtGenRandom is set to true in the EvtExternalGenList + constructor. + +23rd January 2013 John Back +* Added EvtGenExternal/EvtPythiaRandom to allow the use of the EvtGen + random number engine to also be used for the random engine for Pythia 8. +* Added a boolean (useEvtGenRandom, default = true) within the + EvtExternalGenList constructor to use this feature. + +18th December 2012 John Back +* Corrected some wrong daughter ordering assignments for decay modes 5 and + 12 in EvtDDalitz. Updated validation/DalitzDecays.xml to also contain + D decay mode 12, as well as various modes that may use K_S0 and K_L0. +* Added validation/genDDalitzModes.sh and updated validation/compareDalitz.C to + do a complete comparison of the D Dalitz modes with the xml versions. + +11th December 2012 Daniel Craik +* Updated the Xml parser to support named model parameters. +* Updated the generic Dalitz model to use named model parameters as an example. + +15th October 2012 John Back +* Make EvtSimpleRandomEngine inherit from EvtRandomEngine to avoid + crash in EvtGen.cpp when no random engine is defined + - (from Bjoern Spruck). + +=== +## R01-01-00 + +4th October 2012 John Back +* New tag, version "1.1.0", incorporating all changes below. + +* Provide proper default constructors for EvtVector4R and + EvtPhotonParticle. Modified the validation and test code to also + compile/link in the case of no external generators being included. + +3rd October 2012 John Back +* Corrected the t3 vector form factor values for the Ball-Zwicky 2005 + model (modelId = 6) in EvtbTosllBallFF::getVectorFF(), which + were set to t3tilde instead. + +18th September 2012 John Back +* Moved the external generator engines to a new sub-directory + EvtGenExternal. Building the code now creates 2 libraries: + libEvtGen.so (Base+Models) and libEvtGenExternal.so. + - This allows anyone to ignore using the new external generators + if required (by not creating/loading the 2nd library). +* Added prefix option to the configure script/Makefile to allow the user + to specify an installation directory for the include files, libraries, + DECAY.DEC and evt.pdl files (for Genser). + +14th September 2012 Michal Kreps +* Fixed the calculation of the angle between decay planes in the function + EvtKine::EvtDecayAngleChi. Fixed typo in EvtLb2Lll decay model. Only + some NP scenarious could be affected, SM one is definitely unaffected. + +13th September 2012 John Back +* Added the use of the environment variables EVTGEN_PHOTOS, EVTGEN_PYTHIA + and EVTGEN_TAUOLA to specify if the Photos, Pythia and/or Tauola engine + classes are used or not. These variables are set by the configure script, + depending if the library paths are specified for these generators. + +=== +## R01-00-01 + +12th September 2012 John Back +* New tag incorporating all changes below, since R01-00-00. + +11th September 2012 John Back +* Modified the Photos and Tauola engine classes to use the new + Photospp and Tauolapp namespaces that are present in the latest + versions of Photos++(3.5) and Tauola++(1.0.7). +* Updated the configure file to get the correct location of the Tauola++ + include files. +* Added the D0->pi+pi-pi0 decay mode in EvtDDalitz + - from Marco Gersabeck and Frederic Dreyer (LHCb). +* Added new decay models/classes from Alexey Luchinsky (LHCb): + EvtBcVMuNu, EvtTVP, EvtWnPi, EvtSVP, EvtXPsiGamma, EvtBcVNpi + +29th June 2012 John Back +* Corrected mass(squared) variables filled in the Dalitz TTree in + validation/genExampleRootFiles. + +15th May 2012 Daniel Craik +* Updated EvtD0gammaDalitz to deal with D mesons from neutral B->DK +* Added save function to validation/compareDalitz.C. + +11th May 2012 Daniel Craik +* Replaced BaBar specific configuration for BlattWeisskopf birth factors. +* Updated XML conversion script to handle new configuration. +* Fixed some bugs in the XML conversion script related to particle + modifications. + +9th May 2012 Daniel Craik +* Added latex documentation for xml decay files. + +2nd May 2012 Daniel Craik +* Added resDaughters attribute to the Dalitz resonance xml tag to + simplify defining symmetric resonances. Updated validation xml files to + use the new functionality. + +27th April 2012 Daniel Craik +* Upgraded EvtGenericDalitz to use EvtDalitzReso for resonances. +* Added validation to compare EvtGenericDalitz to all 11 EvtDDalitz modes. +* Added a root macro to quickly compare two Dalitz decays for validation. + +24th April 2012 John Back +* Solved two bugs in the EvtD0gammaDalitz model (from Jordi Tico, LHCb): + configuration of the conjugated model, and using only the B charge + to determine the model used, not the D flavour. + +17th April 2012 Daniel Craik +* Updated the GenericDalitz validation code to use the same probMax + values as DDalitz. +* Added XML decay file parsing to EvtGen::readUDecay. + - Dec files are still the default. + +30th March 2012 John Back +* Update maximum probability values in EvtDDalitz::initProbMax() + for all DDalitz modes. + +23rd March 2012 John Back +* Added the EvtEta2MuMuGamma decay model from LHCb. + +21st March 2012 John Back +* Added EvtD0gammaDalitz decay model from LHCb. + +20th March 2012 Daniel Craik +* Added backwards compatibility for Pythia 6 commands in the XML configuration. +* Updated decay file conversion tool to convert JetSetPar lines to pythia6Param + tags. + +19th March 2012 Daniel Craik +* Added infrastructure to pass commands to external generators. +* XML config now takes Pythia8 configuration commands. + +16th March 2012 Daniel Craik +* Added the ability to define particles from the PDL for Dalitz decay + resonances instead of defining mass, width and spin seperately. +* Renamed the lifetime attribute of Dalitz decay resonaces to width to avoid + confusion. +* Added further validation code for the generic Dalitz model. + +15th March 2012 Daniel Craik +* Added validation code for xml decay files and the generic Dalitz model. + +=== +## R01-00-00 + +6th March 2012 John Back +* First official version for Genser (evtgen 1.0.0) that includes + support for external generators: Pythia8, Photos++ and Tauola++. +* This also includes a preliminary version of creating Dalitz plot + decay models using EvtGenericDalitz. diff --git a/History.txt b/History.txt deleted file mode 100644 --- a/History.txt +++ /dev/null @@ -1,648 +0,0 @@ -//========================================================================== -// -// History file for EvtGen. -// From version 2.0.0, Tabc labels refer to Maniphest tasks while -// Dxy labels refer to Differential code reviews on HepForge: -// https://phab.hepforge.org/Tabc -// https://phab.hepforge.org/Dxy -// -//=========================================================================== - -21st Aug 2020 John Back - T109: Add EvtEtaLLPiPi model for eta' -> l l pi pi decays (l = e or mu), - courtesy of Aleksei Luchinsky (LHCb). - -29th Jun 2020 Michal Kreps - T103: Add missing include in EvtGenBase/EvtMatrix.hh. - -15th May 2020 Michal Kreps - D28: Add EvtThreeBodyPhsp (rectangular Dalitz plot selection) and - EvtPhspDecaytimeCut (minimum decay time requirement) models. - D27: Fix initialisation of constants in EvtBTo3hCP model. - -R02-00-00------------------------------------------------------------------- -24th Apr 2020 Michal Kreps - Update particle properties file evt.pdl to 2019 version of RPP by PDG. - -23rd Apr 2020 Tom Latham - Apply copyright and licence notices to all relevant files. - -17th Apr 2020 Tom Latham - Add text of GNU GPLv3 in COPYING, add (preliminary) list of authors in - AUTHORS, and clean-up all source files, prior to applying copyright and - licence notices. - -9th Apr 2020 Tom Latham - Improve, and document use of, standalone installation script. - Apply clang-format formatting to all C++ source files. - -8th Apr 2020 Tom Latham - One small modernisation change to EvtPhotosEngine to match that already - applied in EvtTauolaEngine. - -8th Apr 2020 John Back - Fixed NonReson amplitude and the 4-momentum boosts used for angles in - EvtLambdacPHH, courtesy of Elisabeth Niel (LHCb). - -7th Apr 2020 Gerhard Raven, Tom Latham, Michal Kreps and John Back - Incorporate C++ modernization changes from Gerhard Raven (LHCb). - Merged modernize branch into master. - -9th Mar 2020 John Back - Add EvtAbsExternalGen::getDecayProb() to allow external generators to - return a probability that can be used in EvtDecayProb (default = 1). - -6th Mar 2020 Andrii Verbytskyi and Tom Latham - Implement HepMC3 support: EvtHepMCEvent, external engines & cmake files. - -15th Nov 2019 John Back - Added EvtPsi2JpsiPiPi model for psi2S -> J/psi pi+ pi- decays based on - hep-ph/1507.07985, courtesy of Aleksei Luchinsky (LHCb). - -21st August 2019 Michal Kreps - Added the EvtDToKpienu decay model for D -> K pi e nu decays from - BESIII, courtesy of Liaoyuan Dong. - -16th July 2019 John Back - Correct imaginary sign for EvtComplex /= (EvtComplex c) operator. - -3rd July 2019 John Back - Added the EvtLambdacPHH decay model for Lc -> p K pi decays with K*(890), - Delta++(1232) and Lambda(1520) resonances, based on the Fermilab E791 - analysis hep-ex/9912003v1, courtesy of Elisabeth Niel and Patrick Robbe - (LHCb). Modified EvtResonance2 to accept other barrier factor radii. - -3rd July 2019 Michal Kreps - Make sure minimum mass for resonances with non-zero widths is larger than - 1e-4 GeV in EvtRelBreitWignerBarrierFact. - -3rd May 2019 John Back - Corrected EvtSLDiBaryonAmp bugs/issues in the BToDiBaryonlnupQCD model: - parity, amplitude terms and B momentum reference frame variables. - Corrected treament of spinor indices in EvtRareLb2Lll, courtesy of - Tom Blake and Michal Kreps (LHCb). - Updated the EvtBcVHad model to also handle Bc -> psi Ks K decays, - courtesy of Aleksei Luchinsky (LHCb). - Add new decay model EvtBsMuMuKK (BS_MUMUKK) for Bs to J/psi (mu+mu-) K+K-, - courtesy of Veronika Chobanova, Jeremy Dalseno, Diego Martinez Santos and - Marcos Romero Lamas (LHCb). - Fix infinite loop during initialisation of the EvtBTo3hCP model via - EvtCBTo3piP00 and EvtCBTo3piMPP, courtesy of Peter Richardson (Durham). - -15th March 2019 Tom Latham - Implement cmake build system, replacing the old config method. - -30th Jan 2019 John Back - Fix modernization compiler errors and warnings. - -29th Jan 2019 Michal Kreps - Allow reading decay files which are missing end-of-line before end-of-file. - -21st December 2018 John Back - Imported C++ modernization changes from Gerhard Raven (LHCb). - -7th December 2018 John Back - Added the EvtBLLNuL (BLLNUL) model that generates rare B -> ell ell nu ell - decays, where ell = e or mu, courtesy of Anna Danilina and Nikolai Nikitin - (LHCb). Removed the EvtB2MuMuMuNu (BUTOMMMN) model, since its now replaced - by the more general BLLNuL one. - -5th November 2018 John Back - Added the BToDiBaryonlnupQCD model for generating B to p N* l nu decays, - where N can be any (exited) charged baryon (spin 1/2 or 3/2), courtesy of - Mark Smith and Ryan Newcombe (LHCb), with added code optimisations. - -17th October 2018 John Back - Added various decay models from LHCb EvtGenExtras package: - EvtBcVHad ("BC_VHAD"), Evtbs2llGammaMNT ("BSTOGLLMNT"), - Evtbs2llGammaISRFSR ("BSTOGLLISRFSR"), EvtbTosllMS ("BTOSLLMS"), - EvtbTosllMSExt ("BTOSLLMSEXT"), EvtLb2Baryonlnu ("Lb2Baryonlnu"), - EvtLb2plnuLCSR ("Lb2plnuLCSR"), EvtLb2plnuLQCD ("Lb2plnuLQCD"), - EvtFlatSqDalitz ("FLATSQDALITZ") and EvtPhspFlatLifetime - ("PHSPFLATLIFETIME"). - -5th October 2018 John Back - Updated setupEvtGen.sh to work with the new HepForge Phabricator site. - -13th March 2018 John Back - Updated EvtPythiaEngine to correctly handle updates of various particle - properties so that Pythia uses the same information as EvtGen (evt.pdl) - for the generic and alias PYTHIA decay model. - -12th March 2018 John Back - Updated EvtBcXMuNu models (X = Scalar, Vector, Tensor) to generate - Bc to D0(star) mu nu decays, with associated form factors in EvtBCXFF, - courtesy of Aleksei Luchinsky (LHCb). Also generalised the calculation - of their maximum probabilities by reusing the CalcMaxProb method in - EvtSemiLeptonicAmp, which now allows for different Q^2 binning - (default remains at 25 bins). - -R01-07-00------------------------------------------------------------------- -13th December 2017 John Back - New tag incorporating all changes below. Recommended external packages - are HepMC 2.06.09, pythia 8.230, Photos++ 3.61 and Tauola++ 1.1.6c, - as used in the setupEvtGen.sh script. - -12th December 2017 John Back - Changed Pythia validation example decay files to use Pythia8 codes. - -6th December 2017 John Back - Modified the examples to use DECAY.DEC (see 25th April 2016) instead of - DECAY_2010.DEC. Changed EvtExternalGenList to assume Pythia8 codes are - used in decay files by default, which is the case for DECAY.DEC. Also - updated the setupEvtGen.sh script to work with Pythia 8.2x versions. - -29th November 2017 John Back - Modified EvtSVP, EvtVVP and EvtTVP models to handle both radiative and - two-lepton decays, courtesy of Aleksei Luchinsky (LHCb). - -14th July 2017 John Back - Only create external generator objects if they don't already exist in - EvtExternalGenFactory. Modified configure script to work with Pythia 8.2x - -5th July 2017 Michal Kreps - Register the VTOSLL model. - -14th June 2017 John Back - Add isNeutralKaon() boolean function and corrected comments in EvtDDalitz. - -8th May 2017 Michal Kreps - Fix bug in EvtbTosllVectorAmp to recognise Bs --> K*bar mu mu decay as - b --> d ll transition. - -8th May 2017 Michal Kreps - Significantly simplify way how we decide on decay mode and daughters - ordering in DDalitz model. With new code by definition all orderings of - daughters in the decay file will yield same output. - -4th May 2017 John Back - Further fixes to DDalitz particle ordering (including charge-conjugates): - Mode 5: D0 -> K- K0bar K+ and K+ K- K0bar - Mode 12: D0 -> pi0 pi- pi+ and pi+ pi0 pi- - Removed unneeded index ordering checks for mode 10 (D+ -> pi- pi+ pi+) - and mode 11 (Ds+ -> pi- pi+ pi+) - -27th April 2017 John Back - Fixed DDalitz particle ordering for mode 7: D+ -> pi+ K- K+ and K+ pi+ K- - and their charge-conjugates - -7th April 2017 John Back - Modified EvtGenExternal/EvtPythiaEngine to ensure that the EvtGen-based - instances of Pythia8 (for generic and alias decays) use the same - particle properties as defined by EvtGen, courtesy Patrick Robbe (LHCb). - -5th April 2017 Michal Kreps - Fixed indexing in copy constructor of Evt3Rank3C, which would otherwise - produce an infinite loop; bug report from David Grellscheid. - -3rd November 2016 John Back - Modified EvtFlatQ2 model to work for all B -> X lepton lepton modes, as - well as adding an extra phase space factor to correct for the dip at low - q^2, courtesy of Marcin Chrzaszcz & Thomas Blake (LHCb), which is enabled - by using "FLATQ2 1" instead of just "FLATQ2" in the decay file. - -13th October 2016 John Back - Added the TauolaCurrentOption decfile keyword to select the hadronic - current in Tauola; default is the BaBar-tuned current option (int = 1). - EvtParticles can store double attributes using the functions - setAttributeDouble(name, double) and getAttributeDouble(name), which can - be useful for storing and retrieving amplitude weights, for example. - The analogous EvtParticle integer attribute interface remains unchanged: - setAttribute(name, int) and getAttribute(name). - -13th September 2016 John Back - Modified EvtTauolaEngine to use internal Tauola spin matrices for - tau pair events by temporarily setting the PDG id of the mother as a - boson, keeping the same 4-momentum. The BaBar hadronic currents are now - used by default. Also added the ability to change some Tauola parameters - using the "Define" keyword in decay files. Added an example decay file - illustrating the new features: validation/TauolaFiles/Btautau.dec - -9th September 2016 Michal Kreps - Reimplement code in EvtBTo3pi.F, EvtBTo3piMPP.F, EvtBTo3piP00.F and - EvtBToKpipi.F in C++ in order to remove dependence on Fortran compiler. - With this, there is no internal Fortran code in EvtGen. - -R01-06-00------------------------------------------------------------------- -1st June 2016 John Back - New tag incorporating all changes below. Recommended external packages - are HepMC 2.06.09, pythia 8.186, Photos++ 3.61 and Tauola++ 1.1.5. - -28th April 2016 Michal Kreps - For Ds+ --> 2pi+ pi- there was double counting of branching fraction - resulting in total branching fraction being 1.5 times larger than measured - one. Fix by revisiting submodes, which now fill total Ds --> 3pi. - -25th April 2016 Michal Kreps - Added DECAY.DEC/XML, which contain updated semileptonic charm and beauty - branching fractions using the 2014 PDG, tuned to minimize disagreements - between measurements and EvtGen for both inclusive and exclusive decays. - Updated the evt.pdl particle properties file to the PDG 2014 edition. - - Implemented new LQCD form factors for Lb --> L mu mu from arXiv paper - 1602.01399 (EvtRareLbToLllFFlQCD); old LQCD form factors are removed. - -18th March 2016 John Back - Fixed incorrect spinor algebra used in S1 -> 1/2 S2, 1/2 -> S3 S4 decays - in EvtDiracParticle::rotateToHelicityBasis() functions, courtesy of - Luis Miguel Garcia Martin and the IFIC Valencia LHCb group. - -19th Feburary 2016 John Back - Fixed bug in the definition of the initial spinor term Sinit in - EvtRareLbToLll::HadronicAmpRS(), from Tom Blake (LHCb). - -12th February 2016 John Back - From LHCb, added extensions to the EvtHQET2(FF) model for semitauonic - decays from Brian Hamilton, which needs a patch to EvtSemiLeptonicAmp - from Jack Wimberley to ensure that the q^2 range is physical when - finding the maximum amplitude probability. - -2nd December 2015 John Back - From LHCb, added EvtKStopizmumu model for KS -> pi0 mu mu decays based on - JHEP08(1998)004, courtesy of Veronika Chobanova, Diego Martinez Santos - and Jeremy Dalseno. Added EvtConst::Fermi for Fermi coupling constant. - -R01-05-00------------------------------------------------------------------- -21st October 2015 John Back - New tag incorporating all changes below. Recommended external packages - are HepMC 2.06.09, pythia 8.186, Photos++ 3.61 and Tauola++ 1.1.5. - - Added the EvtB2MuMuMuNu model for simulating the very rare four-leptonic - decays B- -> mu+ mu- anti-nu_mu mu-, courtesy Nikolai Nikitin. - -16th October 2015 John Back - Updated the configure script to automatically select the library names - for PHOTOS++; version 3.56 and below uses Fortran, version 3.61 and above - uses C++ only (default). Avoid using v3.60, since it does not work. - This needs the PHOTOS libraries built before EvtGen is configured. - Modified setupEvtGen.sh to use Photos++ v3.61. - -7th October 2015 John Back - Updated EvtGenExternal/EvtPhotosEngine to check that additional particles - from the outgoing vertex are indeed (FSR) photons, since later versions of - PHOTOS introduce pair emission, where particles may not always be photons. - - Added the genRootDecayChain.cc validation program to create ROOT files - containing information about the complete decay tree. Two example test - decay files BKstarGamma.dec and BuDst0rhop.dec can be used with this; the - first tests PHOTOS, the second looks at sequential decay chain storage. - The plotBKstarGamma.C ROOT macro can be used for B -> K* gamma plots. - -2nd October 2015 John Back - Modified EvtSVPHelAmp and added a new EvtSVPHelCPMix model, implementing - the complete mixing phenomenology of Bs to vector gamma decays, courtesy - of Clara Remon (LHCb). - - EvtD0mixDalitz code: cleanup, inverted q/p for decays of D0bar (simplifies - user decay files) and fixed y parameter bug, courtesy of Jordi Tico (LHCb). - - Changed the initialisation order of the infrared cut-off in EvtPhotosEngine. - This actually has no effect, since the exponentiation function sets it to the - same 1e-7 value, but it's now in the correct order if we need to update it. - - Removed all remaining obsolete pragma (Win32) warnings from some classes. - -23rd September 2015 Michal Kreps - Reimplement the real Spence function in C++ and removed its fortran - implementation. - -15th September 2015 Michal Kreps - Fixed accessed uninitialised memory in EvtPDL.cpp, line 213. - Modified the configure and setupEvtGen.sh scripts to work on Mac; needed - Mac compilation patch files added to the new "platform" subdirectory. - -10th September 2015 John Back - Updated setupEvtGen.sh to use the recommended external packages: - HepMC 2.06.09, pythia 8.186, Photos++ 3.56 and Tauola++ 1.1.5. - - Fixed form-factor calculations for the BTOSLLBALL model 6 used to generate - b -> sll decays, courtesy of Christoph Langenbruch and David Loh (LHCb). - Affects B->K*ll, B->rholl and B->omegall, particularly the electron modes. - - In the validation directory, added runPhotosTest.sh for testing FSR in - Upsilon(4S) -> e+ e- decays, and changed the plot comparison scripts to - use the 2nd directory "oldRootFiles" (which could be a soft-link) for - including ROOT histograms made from a previous version of EvtGen. - -27th August 2015 John Back - Added Mersenne-Twister random number generator (RNG) EvtMTRandomEngine. - It requires c++11 compiler features (>= gcc 4.7), which should - automatically be enabled by the configure script. Introduced the - preprocessor environment variable EVTGEN_CPP11 for c++11 features. - EvtMTRandomEngine is the default RNG for the validation and test examples - if c++11 features are enabled. - - Added a phase-space test validation/genPHSP.sh and PhaseSpacePlots.C to - visually check the flatness of Dalitz plots in order to ensure that the - RNG is not producing biased results that depend on particle ordering. - - Added the models EvtbsToLLLLAmp and EvtbsToLLLLHyperCP for - B0_q -> l+ l- l+ l- decays (SM and one supersymmetric scenario), - courtesy of Nikolai Nikitin and Konstantin Toms. Documentation provided - in doc/evt_BQTOLLLL_model.pdf and doc/evt_BQTOLLLLHYPERCP_model.pdf. - - Changed the installation and set-up script name to be just setupEvtGen.sh; - it uses the VERSION variable to specify the required tag. List of tags - are available using either "svn ls -v http://svn.cern.ch/guest/evtgen/tags" - or by going to http://svn.cern.ch/guest/evtgen/tags in a web browser. - -12th June 2015 John Back - Changed the width of chi_b1 in evt.pdl from 9.8928 GeV (!) to zero. - -1st May 2015 John Back - Added Bc -> scalar ell nu (EvtBcSMuNu) and Bc -> tensor ell nu - (EvtBcTMuNu) decays, courtesy of Jack Wimberley, LHCb. Also included the - chi_c1 mode for EvtBcVMuNu. - -R01-04-00------------------------------------------------------------------- -2nd April 2015 John Back - Removed the EvtStdlibRandomEngine class since this can produce biases - to kinematic distributions when one or more of the daughters is a - resonance, such as B0 -> K pi psi (thanks to Antonio Augusto Alves Jr - who discovered this issue). EvtSimpleRandomEngine is now the default - random number generator in the validation and test examples. - - Incorporated several additions and modifications from LHCb: - a) From Michal Kreps, Tom Blake & Christoph Langenbruch, - added rare Lb --> Lambda^(*) ell ell models described in - arXiv:1108.6129, with various form factors from Gutsche et al. - (arXiv:1301.3737) and lattice QCD (arXiv:1212.4827) - b) From Andrew Crocombe, implemented Bs --> K* form factors - from Ball-Zwicky and z-parametrization form factors from - arXiv:1006.4945 for EvtbTosllBallFF - c) Christoph Langenbruch fixed the Bs -> phi ll form factors in - EvtbTosllBallFF; T3 showed a non-physical pole at very low - q2 which significantly affected the electron mode - d) From Michal Kreps, removed semicolons from wrong places to - clear warnings when compiled with the "-pedantic" option. - -9th October 2014 John Back - Change svnweb.cern.ch to svn.cern.ch in the setup script. - -1st April 2014 John Back - In EvtReport, modified the logging output severity status flags - to have the "EVTGEN_" prefix, e.g. INFO becomes EVTGEN_INFO. - The global report() function has been renamed to EvtGenReport(). - -31st March 2014 John Back - Added the ability to store named attributes for EvtParticles in the - form of a map. The setAttribute(name, value) stores the - required value, while getAttribute(name) retrieves the integer value. - This is used in EvtPhotosEngine to specify the final-state radiation - "FSR" attribute to 1 for any additional photons (EvtPhotonParticles) - created by Photos++. It also stores the "ISR" attribute, but this - is always set to zero, since only FSR photons are created. - If the named attribute doesn't exist, then getAttribute() returns zero. - -29th January 2014 Daniel Craik - Removed mass assertion on GS shape in EvtDalitzReso to allow it to also - be used for charged rho resonances. - -27th January 2014 John Back - Minor corrections to Vub models to remove further gcc 4.8 warnings. - Updated configure script to work for MacOS clang (from Genser team). - -R01-03-00------------------------------------------------------------------- -9th January 2014 John Back - New tag version "1.3.0", incorporating all changes below. - - Replaced auto-install script to work with this version as well as - the latest versions of all external generator packages. - Updated README to mention the new CERN-based web pages for Photos++ - and Tauola++. - -8th January 2014 John Back - Fix gcc 4.6 and 4.8 compilation warnings, courtesy of - Patrick Robbe (LHCb); main changes are removal of unused variables. - Changed the EvtPythiaEngine class and configure script to use new - Pythia 8 header locations; Pythia 8.180 or above is now required. - -7th January 2014 John Back - Modified EvtBCVFF to correct the Kiselev form factors from - Jack Wimberley (LHCb). - -9th October 2013 Daniel Craik - Added Gounaris-Sakurai and Gaussian shapes to EvtGenericDalitz - and set sensible defaults for LASS parameters. - -19th September 2013 John Back - Modified EvtGenExternal/EvtPythiaEngine to keep track of any new - particles that are added to the default Pythia database to avoid - duplicating particle/anti-particle entries that could override - previously defined Pythia decay chains. - -18th September 2013 John Back - Added Mac OS flags for the configure script and src/Makefile. - -15th July 2013 Daniel Craik - Added flag to turn on scaling of LASS amplitude by M/q in EvtDalitzReso - -15th July 2013 Daniel Craik - EvtParserXML now accepts file names containing environment variables, - exponential non-resonant shape in EvtDalitzReso now defined as exp(-alpha*m^2), - LASS shape in EvtDalitzReso now takes a cutoff parameter - -4th July 2013 Daniel Craik - Added LASS, exponential non-resonant and linear non-resonant shapes to EvtGenericDalitz. - -3rd July 2013 Daniel Craik - Fixed auto-install script for R01-02-00. - -1st July 2013 Daniel Craik - Added auto-install script for R01-02-00. - -R01-02-00------------------------------------------------------------------- -15th May 2013 John Back - New tag, version "1.2.0", incorporating all changes below. - -14th May 2013 Michal Kreps - Added Blatt-Weisskopf barrier factors up to L=5 in - EvtGenBase/EvtBlattWeisskopf::compute(). - -14th May 2013 John Back - Added additional entries (appended at the end) to the evt.pdl particle - data file courtesy of Romulus Godang and Belle II colleagues. - -14th March 2013 John Back - Added the method EvtParticle::getPDGId() to get the PDG integer for a - particle directly (which just calls EvtPDL::getStdHep()). - Added a check in EvtPhotosEngine::doDecay to skip Photos if a given - particle has too many daughters (>= 10) to avoid a problem with a - hard coded upper limit in the Photos PHOENE subroutine. - -2nd February 2013 Daniel Craik - Updated EvtDalitzTable to estimate probMax when it is missing from a - Dalitz model. - -1st February 2013 John Back - Added the ability to read in Pythia 6 commands in ascii decay files in - EvtDecayTable::readDecayFile (this was already possible in xml files). - Modified the Photos++ engine default settings to be more suited to B - decays (from LHCb defaults). - -31st January 2013 John Back - Added the ability to read in Pythia 8 commands in ascii decay files - in EvtDecayTable::readDecayFile. They can be set using the syntax: - "PythiaTypeParam module:variable=value", where Type = Generic, Alias or - Both for specifying whether the parameter is for the generic or alias - Pythia decay engines (or both). The 2nd argument must not contain any - spaces. Fixed the list of commands strings being used in the - EvtPythiaEngine class (i.e. Pythia parameters that can be set via decay - files). - -31st January 2013 Daniel Craik - Added named parameters to various decay models. - -30th January 2013 John Back - Fixed some of the parameter arguments used in the EvtSVSCPiso model. - -24th January 2013 John Back - Set the Photos++ and Tauola++ models to use the EvtGen random number - engine when useEvtGenRandom is set to true in the EvtExternalGenList - constructor. - -23rd January 2013 John Back - Added EvtGenExternal/EvtPythiaRandom to allow the use of the EvtGen - random number engine to also be used for the random engine for Pythia 8. - Added a boolean (useEvtGenRandom, default = true) within the - EvtExternalGenList constructor to use this feature. - -18th December 2012 John Back - Corrected some wrong daughter ordering assignments for decay modes 5 and - 12 in EvtDDalitz. Updated validation/DalitzDecays.xml to also contain - D decay mode 12, as well as various modes that may use K_S0 and K_L0. - Added validation/genDDalitzModes.sh and updated - validation/compareDalitz.C to do a complete comparison of the D Dalitz - modes with the xml versions. - -11th December 2012 Daniel Craik - Updated the Xml parser to support named model parameters. Updated the - generic Dalitz model to use named model parameters as an example. - -15th October 2012 John Back - Make EvtSimpleRandomEngine inherit from EvtRandomEngine to avoid - crash in EvtGen.cpp when no random engine is defined - (from Bjoern Spruck). - -R01-01-00------------------------------------------------------------------- -4th October 2012 John Back - New tag, version "1.1.0", incorporating all changes below. - - Provide proper default constructors for EvtVector4R and - EvtPhotonParticle. Modified the validation and test code to also - compile/link in the case of no external generators being included. - -3rd October 2012 John Back - Corrected the t3 vector form factor values for the Ball-Zwicky '05 - model (modelId = 6) in EvtbTosllBallFF::getVectorFF(), which - were set to t3tilde instead. - -18th September 2012 John Back - Moved the external generator engines to a new sub-directory - EvtGenExternal. Building the code now creates 2 libraries: - libEvtGen.so (Base+Models) and libEvtGenExternal.so. - This allows anyone to ignore using the new external generators - if required (by not creating/loading the 2nd library). - - Added prefix option to the configure script/Makefile to allow the user - to specify an installation directory for the include files, libraries, - DECAY.DEC and evt.pdl files (for Genser). - -14th September 2012 Michal Kreps - Fixed the calculation of the angle between decay planes in the function - EvtKine::EvtDecayAngleChi. Fixed typo in EvtLb2Lll decay model. Only - some NP scenarious could be affected, SM one is definitely unaffected. - -13th September 2012 John Back - Added the use of the environment variables EVTGEN_PHOTOS, EVTGEN_PYTHIA - and EVTGEN_TAUOLA to specify if the Photos, Pythia and/or Tauola engine - classes are used or not. These variables are set by the configure script, - depending if the library paths are specified for these generators. - -R01-00-01-------------------------------------------------------------------- -12th September 2012 John Back - New tag incorporating all changes below, since R01-00-00. - -11th September 2012 John Back - Modified the Photos and Tauola engine classes to use the new - Photospp and Tauolapp namespaces that are present in the latest - versions of Photos++(3.5) and Tauola++(1.0.7). Updated the configure file - to get the correct location of the Tauola++ include files. - - Added the D0->pi+pi-pi0 decay mode in EvtDDalitz from Marco Gersabeck - and Frederic Dreyer (LHCb). - - Added new decay models/classes from Alexey Luchinsky (LHCb): - EvtBcVMuNu, EvtTVP, EvtWnPi, EvtSVP, EvtXPsiGamma, EvtBcVNpi - -29th June 2012 John Back - Corrected mass(squared) variables filled in the Dalitz TTree in - validation/genExampleRootFiles. - -15th May 2012 Daniel Craik - Updated EvtD0gammaDalitz to deal with D mesons from neutral B->DK - Added save function to validation/compareDalitz.C. - -11th May 2012 Daniel Craik - Replaced BaBar specific configuration for BlattWeisskopf birth factors. - Updated XML conversion script to handle new configuration. - Fixed some bugs in the XML conversion script related to particle - modifications. - -9th May 2012 Daniel Craik - Added latex documentation for xml decay files. - -2nd May 2012 Daniel Craik - Added resDaughters attribute to the Dalitz resonance xml tag to - simplify defining symmetric resonances. Updated validation xml files to - use the new functionality. - -27th April 2012 Daniel Craik - Upgraded EvtGenericDalitz to use EvtDalitzReso for resonances. - Added validation to compare EvtGenericDalitz to all 11 EvtDDalitz modes. - Added a root macro to quickly compare two Dalitz decays for validation. - -24th April 2012 John Back - Solved two bugs in the EvtD0gammaDalitz model (from Jordi Tico, LHCb): - configuration of the conjugated model, and using only the B charge - to determine the model used, not the D flavour. - -17th April 2012 Daniel Craik - Updated the GenericDalitz validation code to use the same probMax - values as DDalitz. Added XML decay file parsing to EvtGen::readUDecay. - Dec files are still the default. - -30th March 2012 John Back - Update maximum probability values in EvtDDalitz::initProbMax() - for all DDalitz modes. - -23rd March 2012 John Back - Added the EvtEta2MuMuGamma decay model from LHCb. - -21st March 2012 John Back - Added EvtD0gammaDalitz decay model from LHCb. - -20th March 2012 Daniel Craik - Added backwards compatibility for Pythia 6 commands in the XML - configuration. Updated decay file conversion tool to convert JetSetPar - lines to pythia6Param tags. - -19th March 2012 Daniel Craik - Added infrastructure to pass commands to external generators. - XML config now takes Pythia8 configuration commands. - -16th March 2012 Daniel Craik - Added the ability to define particles from the PDL for Dalitz decay - resonances instead of defining mass, width and spin seperately. Renamed - the lifetime attribute of Dalitz decay resonaces to width to avoid - confusion. Added further validation code for the generic Dalitz model. - -15th March 2012 Daniel Craik - Added validation code for xml decay files and the generic Dalitz model. - -R01-00-00 ------------------------------------------------------------------ -6th March 2012 John Back - First official version for Genser (evtgen 1.0.0) that includes - support for external generators: Pythia8, Photos++ and Tauola++. - This also includes a preliminary version of creating Dalitz plot - decay models using EvtGenericDalitz. diff --git a/Pythia8_README.txt b/Pythia8_README.md rename from Pythia8_README.txt rename to Pythia8_README.md --- a/Pythia8_README.txt +++ b/Pythia8_README.md @@ -1,3 +1,4 @@ +# Pythia8 README This README file contains development notes for the EvtGen-Pythia8 interface. Pythia8 version number 8.153 or above is required. @@ -15,10 +16,10 @@ The configure script has been modified to specify the location of the new Pythia 8 libraries. This can be done by using the PYTHIA8DATA environment variable, which is usually set when building Pythia 8 libraries. Otherwise it should -be set using the --pythiadir=[directory] option. +be set using the `--pythiadir=[directory]` option. The main class EvtGen initialises the Pythia interface by doing the following: - +```c++ // Set the Pythia external generator EvtExternalGenFactory* externalGenerators = EvtExternalGenFactory::getInstance(); std::string xmlDir("./xmldoc"); @@ -26,9 +27,9 @@ // We are using Pythia 6 physics codes in the decay.dec file(s). bool convertPhysCode(true); externalGenerators->definePythiaGenerator(xmlDir, convertPhysCode); - +``` The xmlDir string is the location of the XML data files used by Pythia 8. If the -PYTHIA8DATA environment variable is set, then Pythia 8 should automatically pick up +`PYTHIA8DATA` environment variable is set, then Pythia 8 should automatically pick up the right data files. Otherwise, the value of xmlDir must point to a valid directory containing the Pythia 8 XML data file ParticleData.xml. @@ -43,16 +44,16 @@ combinations should be replaced with just "q q'bar" definitions (physics mode 32), since Pythia 8 will generate gluons automatically. In fact the old "q g q'bar" definitions will not work, owing to colour connection issues with how partons are -generated in Pythia 8. The present DECAY.DEC file has these modifications done +generated in Pythia 8. The present `DECAY.DEC` file has these modifications done (only needed for 6 modes). Also, there are some decays with non-standard Pythia 6 physics integers that do not specify any daughters, e.g: - +``` Decay anti-Xi_c0 1.000 PYTHIA 84; Enddecay - +``` For these cases, EvtPythiaEngine will detect that no daughters are defined and will just keep Pythia 8 defaults. Otherwise, errors are generated when such decays are used. @@ -77,7 +78,7 @@ these aliases in turn can use Pythia decays or other decay models. Each alias should then decay according to any definitions specified in the decay.dec file. For example: - +``` Alias Mytau- tau- Alias Mytau+ tau+ ChargeConj Mytau+ Mytau- @@ -94,4 +95,4 @@ Decay Mypi0 1.0 gamma gamma PYTHIA 0; Enddecay - +``` diff --git a/README b/README.md rename from README rename to README.md --- a/README +++ b/README.md @@ -1,94 +1,9 @@ -RELEASE NOTES -============= +# EvtGen README -Please see History.txt for a detailed list of changes to this package. - -The major points comparing this version with the 2009 release are the following: - -1. This version requires HepMC (version 2.04 and above) for storing event structures - of particle decays, and can also use Pythia 8 (version 8.180 and above is required) - and the C++ interfaced packages Photos (version 3.5.2 and above) and Tauola - (version 1.0.7 and above). These external generators are included via engine - classes in the new sub-directory EvtGenExternal. - - Two libraries can be created for EvtGen: - i) libEvtGen.so contains the EvtGenBase and EvtGenModel core code/decay models, - ii) libEvtGenExternal.so contains _only_ the code within EvtGenExternal. - This means that the external generator interface can be ignored by not - loading/creating the 2nd library libEvtGenExternal.so. - - In the installation instructions below, it is possible to select which external - generators you want to use. Note, however, that the generic "DECAY.DEC" file - contains Pythia decays, and if Pythia is not included in the build, these - decays are not generated (in fact, they would need a new decay model specified). - Likewise, if Photos is not included, there will be no radiative corrections - done for particle decays. - - To use the external generators, use the following code: - #include "EvtGenExternal/EvtExternalGenList.hh" - #include "EvtGenBase/EvtAbsRadCorr.hh" - #include "EvtGenBase/EvtDecayBase.hh" - - // Set up the default external generator list: Photos, Pythia and/or Tauola - EvtExternalGenList genList; - EvtAbsRadCorr* radCorrEngine = genList.getPhotosModel(); - std::list extraModels = genList.getListOfModels(); - - // Create the EvtGen generator object - EvtGen myGenerator("decayFile.dec", "evt.pdl", randomEnginePointer, - radCorrEngine, &extraModels); - - //If you don't want to use external generators, use the following: - //EvtGen myGenerator("decayFile.dec", "evt.pdl", randomEnginePointer); - - - The files Pythia8_README.txt and Tauola_README.txt have more details about - using the new Pythia 8 and Tauola generators (called via the PYTHIA and TAUOLA - "decay.dec" model names). The new Photos generator is still called via the PHOTOS - "decay.dec" model name. - - It is now possible to use alias particle decays for the Pythia 8 model. - Two Pythia 8 instances are used in EvtPythiaEngine for normal and aliased decays. - Since the underlying code for Photos and Tauola is still Fortran, it is only - possible to have one (unique) instance of each of these external generators. - This can only be fixed if these packages are converted to pure C++ code. - - -2. This version of EvtGen is effectively a merger of the latest LHCb and BaBar - EvtGenBase and EvtGenModels code. Various decay models have been added, and - there have been a range of bug fixes. - - -3. There is also a new Dalitz decay class model "GENERIC_DALITZ" - (EvtGenModels/EvtGenericDalitz.cpp), that should be used instead of EvtDDalitz. - The generic Dalitz model uses xml files to configure the resonance amplitude - parameters (instead of being hardcoded in EvtDDalitz): - - Decay D+ - 1.0 K- pi+ pi+ GENERIC_DALITZ MyDalitzParameters.xml; - Enddecay - - Examples of xml Dalitz parameter files are given in the sub-directory - validation/DalitzFiles, e.g. see DalitzDecays.xml. - - -4. It is possible to use decay files in xml format. Use the python script - convertDecayFile.py for converting decay files to the new format. - The src/EvtGen.cpp constructor has an additional boolean argument useXml that - needs to be set to true if xml decay files are to be used (default is useXml=false). - For example, DECAY_2010.XML is the xml version of DECAY_2010.DEC. - - -5. Bug fixes for Bs mixing decay/CP violation amplitudes. - Added the capability to use either coherent or incoherent mixing in EvtCPUtil. - One or the other can be chosen as the mixing method for the B system by - choosing 0 (coherent) or 1 (incoherent) for the last integer argument - in the EvtGen() constructor. - - -BUILDING THE CODE -================= +## Introduction +NEED TO WRITE SOMETHING +## Building the code To simplify the procedure you can use the setupEvtGen.sh script, which automates the process of downloading and building EvtGen and all dependencies from source. There are variables in the script that can be edited to set the @@ -126,64 +41,64 @@ Once these packages are available, build the EvtGen release by creating a build directory alongside the EvtGen source directory (assumed here to be called evtgen.git) and running: - +``` cmake ../evtgen.git - +``` within the EvtGen build directory, using the following options: - -DCMAKE_INSTALL_PREFIX= : Location in which to install EvtGen (highly recommended) + `-DCMAKE_INSTALL_PREFIX=` : Location in which to install EvtGen (highly recommended) - -DEVTGEN_HEPMC3=ON : Enable HepMC3 support (default) - To use HepMC2, set this to OFF instead. + `-DEVTGEN_HEPMC3=ON` : Enable HepMC3 support (default) + To use HepMC2, set this to OFF instead. - -DHEPMC3_ROOT_DIR= : Location of HepMC3 install directory - While linking with either HepMC2 or HepMC3 is mandatory, - depending on your environment the installation may be - detected automatically. Failing this, you can specify - the location via this option. + `-DHEPMC3_ROOT_DIR=` : Location of HepMC3 install directory + While linking with either HepMC2 or HepMC3 is mandatory, + depending on your environment the installation may be + detected automatically. Failing this, you can specify + the location via this option. - -DHEPMC2_ROOT_DIR= : Location of HepMC2 install directory - While linking with either HepMC2 or HepMC3 is mandatory, - depending on your environment the installation may be - detected automatically. Failing this, you can specify - the location via this option. + `-DHEPMC2_ROOT_DIR=` : Location of HepMC2 install directory + While linking with either HepMC2 or HepMC3 is mandatory, + depending on your environment the installation may be + detected automatically. Failing this, you can specify + the location via this option. - -DEVTGEN_PYTHIA=ON : Enable linking with Pythia 8 (OFF by default) + `-DEVTGEN_PYTHIA=ON` : Enable linking with Pythia 8 (OFF by default) - -DPYTHIA8_ROOT_DIR= : Location of Pythia8 install directory - As with HepMC this may be automatically detected - depending on your build environment, otherwise the - location can be specified via this option. + `-DPYTHIA8_ROOT_DIR=` : Location of Pythia8 install directory + As with HepMC this may be automatically detected + depending on your build environment, otherwise the + location can be specified via this option. - -DEVTGEN_PHOTOS=ON : Enable linking with Photos++ (OFF by default) + `-DEVTGEN_PHOTOS=ON` : Enable linking with Photos++ (OFF by default) - -DPhotos++_ROOT_DIR= + `-DPhotos++_ROOT_DIR=` or - -DPHOTOSPP_ROOT_DIR= : Location of Photos++ install directory - As with HepMC this may be automatically detected - depending on your build environment, otherwise the - location can be specified via this option. + `-DPHOTOSPP_ROOT_DIR=` : Location of Photos++ install directory + As with HepMC this may be automatically detected + depending on your build environment, otherwise the + location can be specified via this option. - -DEVTGEN_TAUOLA=ON : Enable linking with Tauola++ (OFF by default) + `-DEVTGEN_TAUOLA=ON` : Enable linking with Tauola++ (OFF by default) - -DTauola++_ROOT_DIR= + `-DTauola++_ROOT_DIR=` or - -DTAUOLAPP_ROOT_DIR= : Location of Tauola++ install directory - As with HepMC this may be automatically detected - depending on your build environment, otherwise the - location can be specified via this option. + `-DTAUOLAPP_ROOT_DIR=` : Location of Tauola++ install directory + As with HepMC this may be automatically detected + depending on your build environment, otherwise the + location can be specified via this option. - -DEVTGEN_BUILD_DOC=ON : Enable building documentation in 'doc' directory (OFF by default) + `-DEVTGEN_BUILD_DOC=ON` : Enable building documentation in 'doc' directory (OFF by default) - -DEVTGEN_BUILD_TESTS=ON : Enable building executables in 'test' directory (OFF by default) + `-DEVTGEN_BUILD_TESTS=ON` : Enable building executables in 'test' directory (OFF by default) - -DEVTGEN_BUILD_VALIDATIONS=ON : Enable building executables in 'validation' directory (OFF by default) + `-DEVTGEN_BUILD_VALIDATIONS=ON` : Enable building executables in 'validation' directory (OFF by default) Then compile and (optionally, although highly recommended) install the EvtGen code using - +``` make make install - +``` This should create the libraries libEvtGen.so and libEvtGenExternal.so, as well as the archives libEvtGen.a and libEvtGenExternal.a (the "EvtGenExternal" library/archive will not be created if linking is not enabled for any of the external generators). @@ -197,12 +112,10 @@ To use Pythia 8, the environment variable PYTHIA8DATA needs to be set to the location of the corresponding xml documentation directory, which also contains the default values -for particle decays and models: /xmldoc +for particle decays and models: `/xmldoc` -Code validation -=============== - +## Code validation The validation sub-directory contains code validation test cases for Pythia, Tauola and B mixing models. @@ -219,13 +132,102 @@ The testCPVDecays.cc program runs a test for the B mixing decay model. -Examples -======== - +## Examples Some examples are provided in the test sub-directory. Note that these executables also depend on ROOT, which is only used to create ntuples and plots for the validation examples. -Running the script "./do_tests" will run a series of EvtGen examples. +Running the script `./do_tests` will run a series of EvtGen examples. Example decay files are in the test/exampleFiles sub-directory. + + +## Release notes +Please see [History.md](History.md) for a detailed list of changes to this package. + +The major points comparing this version with the 2009 release are the following: + +1. This version requires HepMC (version 2.04 and above) for storing event structures + of particle decays, and can also use Pythia 8 (version 8.180 and above is required) + and the C++ interfaced packages Photos (version 3.5.2 and above) and Tauola + (version 1.0.7 and above). These external generators are included via engine + classes in the new sub-directory EvtGenExternal. + + Two libraries can be created for EvtGen: + i) libEvtGen.so contains the EvtGenBase and EvtGenModel core code/decay models, + ii) libEvtGenExternal.so contains _only_ the code within EvtGenExternal. + This means that the external generator interface can be ignored by not + loading/creating the 2nd library libEvtGenExternal.so. + + In the installation instructions below, it is possible to select which external + generators you want to use. Note, however, that the generic "DECAY.DEC" file + contains Pythia decays, and if Pythia is not included in the build, these + decays are not generated (in fact, they would need a new decay model specified). + Likewise, if Photos is not included, there will be no radiative corrections + done for particle decays. + + To use the external generators, use the following code: + ```c++ + #include "EvtGenExternal/EvtExternalGenList.hh" + #include "EvtGenBase/EvtAbsRadCorr.hh" + #include "EvtGenBase/EvtDecayBase.hh" + + // Set up the default external generator list: Photos, Pythia and/or Tauola + EvtExternalGenList genList; + EvtAbsRadCorr* radCorrEngine = genList.getPhotosModel(); + std::list extraModels = genList.getListOfModels(); + + // Create the EvtGen generator object + EvtGen myGenerator("decayFile.dec", "evt.pdl", randomEnginePointer, + radCorrEngine, &extraModels); + + //If you don't want to use external generators, use the following: + //EvtGen myGenerator("decayFile.dec", "evt.pdl", randomEnginePointer); + ``` + + The files [Pythia8_README.md](Pythia8_README.md) and [Tauola_README.md](Tauola_README.md) have more details about + using the new Pythia 8 and Tauola generators (called via the PYTHIA and TAUOLA + "decay.dec" model names). The new Photos generator is still called via the PHOTOS + "decay.dec" model name. + + It is now possible to use alias particle decays for the Pythia 8 model. + Two Pythia 8 instances are used in EvtPythiaEngine for normal and aliased decays. + Since the underlying code for Photos and Tauola is still Fortran, it is only + possible to have one (unique) instance of each of these external generators. + This can only be fixed if these packages are converted to pure C++ code. + + +2. This version of EvtGen is effectively a merger of the latest LHCb and BaBar + EvtGenBase and EvtGenModels code. Various decay models have been added, and + there have been a range of bug fixes. + + +3. There is also a new Dalitz decay class model "GENERIC_DALITZ" + (EvtGenModels/EvtGenericDalitz.cpp), that should be used instead of EvtDDalitz. + The generic Dalitz model uses xml files to configure the resonance amplitude + parameters (instead of being hardcoded in EvtDDalitz): + + ``` + Decay D+ + 1.0 K- pi+ pi+ GENERIC_DALITZ MyDalitzParameters.xml; + Enddecay + ``` + + Examples of xml Dalitz parameter files are given in the sub-directory + validation/DalitzFiles, e.g. see DalitzDecays.xml. + + +4. It is possible to use decay files in xml format. Use the python script + convertDecayFile.py for converting decay files to the new format. + The src/EvtGen.cpp constructor has an additional boolean argument useXml that + needs to be set to true if xml decay files are to be used (default is useXml=false). + For example, DECAY_2010.XML is the xml version of DECAY_2010.DEC. + + +5. Bug fixes for Bs mixing decay/CP violation amplitudes. + Added the capability to use either coherent or incoherent mixing in EvtCPUtil. + One or the other can be chosen as the mixing method for the B system by + choosing 0 (coherent) or 1 (incoherent) for the last integer argument + in the EvtGen() constructor. + + diff --git a/Tauola_README.txt b/Tauola_README.md rename from Tauola_README.txt rename to Tauola_README.md --- a/Tauola_README.txt +++ b/Tauola_README.md @@ -1,11 +1,12 @@ +# Tauola README The TAUOLA external event generator can be used to decay tau particles. The syntax for decay.dec files is - +``` Decay tau- TAUOLA ; Enddecay - -where is the relative branching fraction (0 to 1) and modeInt is the +``` +where `` is the relative branching fraction (0 to 1) and `modeInt` is the integer value specifying what TAUOLA decay is to be generated. Note that the daughter particle types of the mode are not specified within the "Decay" command - the mode integer will generate the correct daughters for you. @@ -42,25 +43,25 @@ For example, to generate tau- -> 3pi0 pi- nu_tau (40%) and tau- -> mu- anti-nu_mu nu_tau (60%), use - +``` Decay Mytau- 0.4 TAUOLA 9; 0.6 TAUOLA 2; Enddecay CDecay Mytau+ - +``` To ensure decay mode consistency, any tau particle decay definition (normal or alised) using TAUOLA should use it for all sub-modes, i.e do not mix TAUOLA and other decay models, such as phase space (PHSP), within the same "Decay" definition. An example which is NOT allowed is: - +``` Decay Mytau+ 0.4 TAUOLA 9; 0.5 TAUOLA 2; 0.1 e+ nu_e anti-nu_tau PHSP; # Decay model is not TAUOLA. Enddecay - +``` If this is detected, the program will stop and ask you to correct the decay definition(s). The reason for this limitation is due to the fact that TAUOLA decays any tau particles by considering the kinematics of its parent particle and the rest of the daughters, one of @@ -74,7 +75,7 @@ If a particle decay contains at least two tau particles, and one of these uses TAUOLA decay modes, then all other tau particles should use the same TAUOLA decay definitions to ensure consistency: - +``` Alias MyB0 B0 Alias Myanti-B0 anti-B0 ChargeConj Myanti-B0 MyB0 @@ -93,7 +94,7 @@ 0.6 TAUOLA 2; Enddecay CDecay Mytau- - +``` You should not define two or more (via aliases) tau decays with different TAUOLA sub-mode branching fractions. Also tau- and tau+ particles must have the same decay modes/branching fractions. These limitions are due to the fact that the core code @@ -110,7 +111,7 @@ 2) Define the allowed decay modes for the tau- and tau+ particle, using only TAUOLA modes. It is possible to keep the decay.dec generic (non-TAUOLA) decay modes for tau- and tau+, and create aliased tau ("signal") particles such as Mytau- and Mytau+ to only use TAUOLA modes: - +``` Alias Mytau- tau- Alias Mytau+ tau+ ChargeConj Mytau+ Mytau- @@ -120,7 +121,7 @@ 0.6 TAUOLA 2; Enddecay CDecay Mytau+ - +``` 3) Make sure the TAUOLA modes for tau+ match those for tau- (easily done by using "CDecay"). 4) Do not create other (alised) tau particles using TAUOLA modes. These settings will be ignored. diff --git a/doxygen/CMakeLists.txt b/doxygen/CMakeLists.txt new file mode 100644 --- /dev/null +++ b/doxygen/CMakeLists.txt @@ -0,0 +1,66 @@ + +######################################################################## +# Copyright 1998-2021 CERN for the benefit of the EvtGen authors # +# # +# This file is part of EvtGen. # +# # +# EvtGen is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# EvtGen is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with EvtGen. If not, see . # +######################################################################## + +# - CMake buildscript for Doxygen documentation subdirectory + +# - Doxygen documentation +# Find an install of Doxygen (we're not too fussy about the version) using CMake's find_package command +find_package(Doxygen REQUIRED) + +# Configure+Copy Doxygen template file from current source dir to current binary dir +# '@ONLY' means replace any instances of '@VARIABLE@' in the input file with +# the value of the CMake variable named 'VARIABLE' in the output file +configure_file(Doxyfile.in Doxyfile @ONLY) +configure_file(mainpage.dox.in mainpage.dox @ONLY) +configure_file(../AUTHORS AUTHORS.md @ONLY) + +# Run Doxygen +add_custom_command( + # What this command generates + OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/html/index.html" + # Actually run doxygen + COMMAND ${DOXYGEN_EXECUTABLE} + # ... in the same directory as we generated the Doxyfile... + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + # Output requires regeneration when + # i - we modify the Doxygen configuration + # ii - the sources being documented change + # iii - any auxillary inputs change + DEPENDS Doxyfile.in mainpage.dox.in ${PROJECT_SOURCE_DIR}/AUTHORS ${PROJECT_SOURCE_DIR}/README.md ${PROJECT_SOURCE_DIR}/Pythia8_README.md ${PROJECT_SOURCE_DIR}/Tauola_README.md ${PROJECT_SOURCE_DIR}/History.md ${PROJECT_SOURCE_DIR}/EvtGen ${PROJECT_SOURCE_DIR}/EvtGenBase ${PROJECT_SOURCE_DIR}/EvtGenModels ${PROJECT_SOURCE_DIR}/EvtGenExternal ${PROJECT_SOURCE_DIR}/src + # Log that the command is run + COMMENT "Building Doxygen for ${PROJECT_NAME}" + ) + +# However, adding a command doesn't change anything in the build +# system - need to create a target that depends on the output of the +# command. +add_custom_target( + # Name of the target - e.g. in Makefiles we can run 'make doc' + doc + # Add this target to the default target - i.e. documentation is + # always built when building the whole project + ALL + # Make it depend on the output of the custom command + DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/html/index.html" + ) + +# Install the documentation +install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR}) + diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in new file mode 100644 --- /dev/null +++ b/doxygen/Doxyfile.in @@ -0,0 +1,2437 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "@PROJECT_NAME@" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "@PROJECT_VERSION@" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "@PROJECT_DESCRIPTION@" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = "@PROJECT_SOURCE_DIR@" "@CMAKE_CURRENT_BINARY_DIR@" + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = "@PROJECT_SOURCE_DIR@" + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = "@PROJECT_SOURCE_DIR@/EvtGen" \ + "@PROJECT_SOURCE_DIR@/EvtGenBase" \ + "@PROJECT_SOURCE_DIR@/EvtGenModels" \ + "@PROJECT_SOURCE_DIR@/EvtGenExternal" \ + "@PROJECT_SOURCE_DIR@/src" \ + "@PROJECT_SOURCE_DIR@/src/EvtGenBase" \ + "@PROJECT_SOURCE_DIR@/src/EvtGenModels" \ + "@PROJECT_SOURCE_DIR@/src/EvtGenExternal" \ + "@PROJECT_SOURCE_DIR@/README.md" \ + "@PROJECT_SOURCE_DIR@/Pythia8_README.md" \ + "@PROJECT_SOURCE_DIR@/Tauola_README.md" \ + "@PROJECT_SOURCE_DIR@/History.md" \ + "@CMAKE_CURRENT_BINARY_DIR@/AUTHORS.md" \ + "@CMAKE_CURRENT_BINARY_DIR@/mainpage.dox" + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.cpp *.hh + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +#CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +#CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /