diff --git a/README b/README new file mode 100644 index 0000000..f66566a --- /dev/null +++ b/README @@ -0,0 +1,60 @@ +------------------------------------------ +- High Energy Jets - +------------------------------------------ + +High Energy Jets (HEJ) is a Monte Carlo generator for all-order summation of +high-energy logarithms. It can be used as both a C++ library and standalone +executable. + +For further informations and questions please visit + + http://hej.web.cern.ch/ + +The latest version can be downloaded from + + https://phab.hepforge.org/source/hej/repository/v2.0/ + +------------- Installation ------------- + +HEJ can be installed via CMake version 3.1 or later (https://cmake.org/) by +running + + mkdir build + cd build + cmake .. -DCMAKE_INSTALL_PREFIX=target/directory + make install + +Replace "target/directory" with the directory where HEJ should be installed to. + +HEJ depends on multiple external packages, a full list is given in the user +documentation (i.e. http://hej.web.cern.ch/). The minimal requirements are: + + A compiler supporting the C++14 standard (e.g. gcc 5 or later) + CLHEP (https://gitlab.cern.ch/CLHEP/CLHEP) + FastJet (http://fastjet.fr/) + IOStreams and uBLAS for the boost library (https://boost.org/) + LHAPDF (https://lhapdf.hepforge.org/) + yaml-cpp (https://github.com/jbeder/yaml-cpp) + +We also provide a Fixed Order Generator for the HEJ matrix elements as a +separate executable. To install it run the same commands as above in the +"FixedOrderGen" directory. + +------------- Documentation ------------- + +All documentation is hosted on + + http://hej.web.cern.ch/ + +To generate the user documentation locally run +(requires sphinx http://sphinx-doc.org/) + + cd doc/sphinx + make html + firefox _build/html/index.html + +The code documentation can be build through doxygen (http://doxygen.org/); + + cd doc/doxygen + doxygen Doxyfile + firefox html/index.html