Page MenuHomeHEPForge
Files F8723883

No OneTemporary
Actions

View Options

diff --git a/doc/sphinx/installation.rst b/doc/sphinx/installation.rst
index 1d9de77..92a71b3 100644
--- a/doc/sphinx/installation.rst
+++ b/doc/sphinx/installation.rst
@@ -1,91 +1,91 @@
.. _Installation:
Installation
============
Download
--------
A tar archive of the HEJ 2 source code can be downloaded and
decompressed with the command::
curl https://hej.web.cern.ch/HEJ/downloads/HEJ_2.0.tar.gz | tar -xz
To obtain the latest stable HEJ version, `HEJ_2.0.tar.gz` should be
replaced by `HEJ.tar.gz`.
Alternatively, the HEJ source code can be obtained by installing the
`git version control system <https://git-scm.com/>`_. and running::
git clone https://phab.hepforge.org/source/hej.git
We also provide a `Docker image <https://hub.docker.com/r/hejdock/hej>`_
containing a HEJ 2 installation on. This image can be pulled with::
docker pull hejdock/hej
When using the Docker image the remaining installation steps can be
skipped.
Prerequisites
-------------
Before installing HEJ 2, you need the following programs and
libraries:
- `CMake <https://cmake.org/>`_ version 3.1
- A compiler supporting the C++14 standard, for example `gcc <https://gcc.gnu.org/>`_ 5 or later
- `FastJet <http://fastjet.fr/>`_
- `CLHEP <https://gitlab.cern.ch/CLHEP/CLHEP>`_
- `LHAPDF <https://lhapdf.hepforge.org/>`_
- The `IOStreams` and `uBLAS` `boost <https://www.boost.org>`_ libraries
- `yaml-cpp <https://github.com/jbeder/yaml-cpp>`_
In addition, some optional features have additional dependencies:
-- To include finite top mass corrections in Higgs boson + jets
- production, you additionally need version 2 of the `QCDLoop
- <https://github.com/scarrazza/qcdloop>`_ library.
-- HEJ 2 supports versions 2 and 3 of `HepMC
- <https://hepmc.web.cern.ch/hepmc/>`_ as event output format if HepMC
- is installed.
-- If both HepMC 2 and `Rivet <https://rivet.hepforge.org/>`_ are
- available, HEJ 2 can use Rivet analyses.
-- To read event files in the in the `HDF5 <https://www.hdfgroup.org/>`_-based
- format suggested in `arXiv:1905.05120 <https://arxiv.org/abs/1905.05120>`_
- `HighFive <https://github.com/BlueBrain/HighFive>`_ has to be installed.
+- `Version 2 of QCDLoop <https://github.com/scarrazza/qcdloop>`_ is
+ required to include finite top mass corrections in Higgs boson + jets
+ production.
+- `HepMC versions 2 and 3 <https://hepmc.web.cern.ch/hepmc/>`_ enable
+ event output in the respective format.
+- `Rivet <https://rivet.hepforge.org/>`_ together with HepMC 2 allow
+ using Rivet analyses.
+- `HighFive <https://github.com/BlueBrain/HighFive>`_ has to be
+ installed in order to read event files in the
+ `HDF5 <https://www.hdfgroup.org/>`_-based format suggested in
+ `arXiv:1905.05120 <https://arxiv.org/abs/1905.05120>`_.
Compilation
-----------
To compile and install HEJ 2 run::
cmake source/directory -DCMAKE_INSTALL_PREFIX=target/directory
make install
:file:`source/directory` is the directory containing the file
:file:`CMakeLists.txt`. If you omit
:code:`-DCMAKE_INSTALL_PREFIX=target/directory` HEJ 2 will be
installed to some default location.
In case some of the aforementioned prerequisites are not found by
:code:`cmake` you can give a hint by adding an additional argument
:code:`-Dlibname_ROOT_DIR=/directory/with/library`, where
:code:`libname` should be replaced by the name of the library in
question.
To not include specific packages one can add
:code:`-DEXCLUDE_packagename=TRUE` to :code:`cmake`, e.g. by
setting :code:`-DEXCLUDE_rivet=TRUE` HEJ 2 will not be interfaced
to `rivet` even if rivet is available on the system.
Testing
-------
To test your installation, download the NNPDF 2.3 PDF set with::
lhapdf install NNPDF23_nlo_as_0119
and run::
make test

File Metadata

Mime Type
text/x-diff
Expires
Mon, Jan 20, 9:49 PM (1 d, 5 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4242535
Default Alt Text
(3 KB)

Event Timeline