Page MenuHomeHEPForge
Files F8723708

No OneTemporary
Actions

View Options

diff --git a/doc/sphinx/HEJFOG.rst b/doc/sphinx/HEJFOG.rst
index 13060f0..4597f85 100644
--- a/doc/sphinx/HEJFOG.rst
+++ b/doc/sphinx/HEJFOG.rst
@@ -1,232 +1,233 @@
The HEJ Fixed Order Generator
=============================
For high jet multiplicities event generation with standard fixed-order
generators becomes increasingly cumbersome. For example, the
leading-order production of a Higgs Boson with five or more jets is
computationally prohibitively expensive.
To this end, reversed HEJ provides the ``HEJ FOG`` fixed-order generator
that allows to generate events with high jet multiplicities. To
facilitate the computation the limit of Multi-Regge Kinematics with
large invariant masses between all outgoing particles is assumed in the
matrix elements. The typical use of the ``HEJ FOG`` is to supplement
low-multiplicity events from standard generators with high-multiplicity
events before using the reversed HEJ program to add high-energy
resummation.
Installation
------------
The ``HEJ FOG`` comes bundled together with reversed HEJ and the
installation is very similar. After downloading reversed HEJ and
installing the prerequisites as described in :ref:`Installation` the ``HEJ
FOG`` can be installed with::
cmake /path/to/FixedOrderGen -DCMAKE_INSTALL_PREFIX=target/directory -DCMAKE_BUILD_TYPE=Release
make install
where :file:`/path/to/FixedOrderGen` refers to the :file:`FixedOrderGen`
subdirectory in the reversed HEJ directory. The installation can be
tested with::
make test
provided that the NNPDF 3.0 PDF set is installed.
Running the fixed-order generator
---------------------------------
After installing the ``HEJ FOG`` you can modify the provided
configuration file :file:`configFO.yml` and run the generator with::
FOgen configFO.yml
The resulting event file, by default named :file:`HEJFO.lhe`, can then be
fed into reversed HEJ like any event file generated from a standard
fixed-order generator, see :ref:`Running reversed HEJ`.
Settings
--------
Similar to reversed HEJ, the ``HEJ FOG`` uses a `YAML
<http://yaml.org/>`_ configuration file. The settings are
.. _`process`:
**process**
The scattering process for which events are being generated. The
format is
:code:`in1 in2 => out1 out2 ...`
The incoming particles, :code:`in1`, :code:`in2` can be
- quarks: :code:`u`, :code:`d`, :code:`u_bar`, and so on
- gluons: :code:`g`
- protons :code:`p` or antiprotons :code:`p_bar`
At most one of the outgoing particles can be a boson. At the moment
only the Higgs boson :code:`h` is supported. All other outgoing
particles are jets. Multiple jets can be grouped together, so
:code:`p p => h j j` is the same as :code:`p p => h 2j`. There have
to be at least two jets.
.. _`events`:
**events**
Specifies the number of events to generate.
.. _`jets`:
**jets**
Defines the properties of the generated jets.
.. _`jets: min pt`:
**min pt**
Minimum jet transverse momentum in GeV.
.. _`jets: algorithm`:
**algorithm**
The algorithm used to define jets. Allowed settings are
:code:`kt`, :code:`cambridge`, :code:`antikt`, :code:`genkt`,
:code:`cambridge for passive`, :code:`genkt for passive`,
:code:`ee kt`, :code:`ee genkt`. See the `FastJet
<http://fastjet.fr/>`_ documentation for a description of these
algorithms.
.. _`jets: R`:
**R**
The R parameter used in the jet algorithm.
.. _`jets: max rapidity`:
**max rapidity**
Maximum absolute value of the jet rapidity.
.. _`beam`:
**beam**
Defines various properties of the collider beam.
.. _`beam: energy`:
**energy**
The beam energy in GeV. For example, the 13
TeV LHC corresponds to a value of 6500.
.. _`beam: particles`:
**particles**
A list :code:`[p1, p2]` of two beam particles. The only supported
entries are protons :code:`p` and antiprotons :code:`p_bar`.
.. _`pdf`:
**pdf**
The LHAPDF number of the PDF set. For example, 230000 corresponds
to an NNPDF 2.3 NLO PDF set.
.. _`unordered fraction`:
**unordered fraction**
This setting is related to the fraction of events where a gluon is
emitted outside the rapidity ordering required in FKL events. More
precisely, if at least one of the incoming particles is a quark or
antiquark and there are more than two jets in the final state, this
states the probability that the flavours of the outgoing particles
are assigned in such a way that an unordered configuration
arises. Typically, this value should be between 0.01 and 0.1.
.. _`unweight`:
**unweight**
This setting defines the parameters for the partial unweighting of
events. You can disable unweighting by removing this entry from the
configuration file.
.. _`unweight: sample size`:
**sample size**
The number of weighted events used to calibrate the unweighting.
A good default is to set this to the number of target
`events`_. If the number of `events`_ is large this can
lead to significant memory consumption and a lower value should be
chosen. Contrarily, for large multiplicities the unweighting
efficiency becomes worse and the sample size should be increased.
.. _`unweight: max deviation`:
**max deviation**
Controls the range of events to which unweighting is applied. A
larger value means that a larger fraction of events are unweighted.
Typical values are between -1 and 1.
.. _`Higgs properties`:
**Higgs properties**
Specifies various properties of the Higgs boson. This is only
relevant if the chosen `process`_ is the production of a Higgs boson
with jets.
.. _`Higgs properties: mass`:
**mass**
The mass of the Higgs boson in GeV.
**width**
The total decay width of the Higgs boson in GeV.
**decays**
Optional setting specifying the decays of the Higgs boson. This is
treated as the production and subsequent decay of an on-shell
Higgs boson, so decays into e.g. Z bosons are not supported. Only
the decay into two particles is implemented. Each decay has the
form
:code:`{into: [p1,p2], branching ratio: r}`
where :code:`p1` and :code:`p2` are the particle names of the
decay product (e.g. :code:`photon`) and :code:`r` is the branching
ratio.
.. _`scales`:
**scales**
Specifies the renormalisation and factorisation scales for the output
events. For details, see the corresponding entry in the reversed HEJ
:ref:`reversed HEJ settings`. Note that this should usually be a
single value, as the weights resulting from additional scale choices
will simply be ignored by reversed HEJ.
.. _`event output`:
**event output**
Specifies the name of a single event output file or a list of such
files. See the corresponding entry in the reversed HEJ
:ref:`reversed HEJ settings` for details.
.. _`RanLux init`:
-**RanLux init**
- Specifies a file to be loaded for the initialisation of the RanLux64
- random number generation. See the corresponding entry in the reversed
- HEJ :ref:`reversed HEJ settings` for details.
+.. _`random generator`:
+
+**random generator**
+ Sets parameters for random number generation. See the :ref:`reversed
+ HEJ settings` for details.
.. _`analysis`:
**analysis**
Specifies the name and settings for a custom analysis library. This
can be useful to specify cuts at the fixed-order level. See the
corresponding entry in the reversed HEJ :ref:`reversed HEJ settings`
for details.
.. _`Higgs coupling`:
**Higgs coupling**
This collects a number of settings concerning the effective coupling
of the Higgs boson to gluons. See the corresponding entry in the
reversed HEJ :ref:`reversed HEJ settings` for details.
diff --git a/doc/sphinx/rHEJ.rst b/doc/sphinx/rHEJ.rst
index 4eae78e..38ec918 100644
--- a/doc/sphinx/rHEJ.rst
+++ b/doc/sphinx/rHEJ.rst
@@ -1,268 +1,280 @@
.. _`Running reversed HEJ`:
Running reversed HEJ
====================
Quick start
-----------
In order to run reversed HEJ, you need a configuration file and a file
containing fixed-order events. A sample configuration is given by the
:file:`config.yml` file distributed together with reversed HEJ. Events
in the Les Houches Event File format can be generated with standard
Monte Carlo generators like `MadGraph5_aMC@NLO
<https://launchpad.net/mg5amcnlo>`_ or `Sherpa
<https://sherpa.hepforge.org/trac/wiki>`_. Reversed HEJ assumes that the
cross section is given by the sum of the event weights. Depending on the
fixed-order generator it may be necessary to adjust the weights in the
Les Houches Event File accordingly.
The processes supported by reversed HEJ are
- Pure multijet production
- Production of a Higgs boson with jets
..
- *TODO* Production of a W boson with jets
- *TODO* Production of a Z boson or photon with jets
where at least two jets are required in each case. For the time being,
only leading-order events are supported.
After generating an event file :file:`events.lhe` adjust the parameters
under the `fixed order jets`_ setting in :file:`config.yml` to the
settings in the fixed-order generation. Resummation can then be added by
running::
rHEJ config.yml events.lhe
Using the default settings, this will produce an output event file
:file:`RHEJ.lhe` with events including high-energy resummation.
.. _`reversed HEJ settings`:
Settings
--------
Reversed HEJ configuration files follow the `YAML <http://yaml.org/>`_
format. The following configuration parameters are supported:
.. _`trials`:
**trials**
High-energy resummation is performed by generating a number of
resummation phase space configurations corresponding to the input
fixed-order event. This parameter specifies how many such
configurations reversed HEJ should try to generate for each input
event. Typical values vary between 10 and 100.
.. _`min extparton pt`:
**min extparton pt**
Specifies the minimum transverse momentum in GeV of the most forward
and the most backward parton. This setting is needed to regulate an
otherwise uncancelled divergence. Its value should be slightly below
the minimum transverse momentum of jets specified by `resummation
jets: min pt`_. See also the `max ext soft pt fraction`_ setting.
.. _`max ext soft pt fraction`:
**max ext soft pt fraction**
Specifies the maximum fraction that soft radiation can contribute to
the transverse momentum of each the most forward and the most backward
jet. Values between around 0.05 and 0.1 are recommended. See also the
`min extparton pt`_ setting.
.. _`fixed order jets`:
**fixed order jets**
This tag collects a number of settings specifying the jet definition
in the event input. The settings should correspond to the ones used in
the fixed-order Monte Carlo that generated the input events.
.. _`fixed order jets: min pt`:
**min pt**
Minimum transverse momentum in GeV of fixed-order jets.
.. _`fixed order jets: algorithm`:
**algorithm**
The algorithm used to define jets. Allowed settings are
:code:`kt`, :code:`cambridge`, :code:`antikt`, :code:`genkt`,
:code:`cambridge for passive`, :code:`genkt for passive`,
:code:`ee kt`, :code:`ee genkt`. See the `FastJet
<http://fastjet.fr/>`_ documentation for a description of these
algorithms.
.. _`fixed order jets: R`:
**R**
The R parameter used in the jet algorithm, roughly corresponding
to the jet radius in the plane spanned by the rapidity and the
azimuthal angle.
.. _`resummation jets`:
**resummation jets**
This tag collects a number of settings specifying the jet definition
in the observed, i.e. resummed events. These settings are optional, by
default the same values as for the `fixed order jets`_ are assumed.
.. _`resummation jets: min pt`:
**min pt**
Minimum transverse momentum in GeV of resummation jets. This
should be around 25% larger than the minimum transverse momentum
of fixed order jets set by `fixed order jets: min pt`_.
.. _`resummation jets: algorithm`:
**algorithm**
The algorithm used to define jets. The reversed HEJ approach to
resummation relies on properties of :code:`antikt` jets, so this
value is strongly recommended. For a list of possible other
values, see the `fixed order jets: algorithm`_ setting.
.. _`resummation jets: R`:
**R**
The R parameter used in the jet algorithm.
.. _`FKL`:
**FKL**
Specifies how to treat FKL events. The possible values are
:code:`reweight` to enable resummation, :code:`keep` to keep the
events as they are up to a possible change of renormalisation and
factorisation scale, and :code:`discard` to discard these events.
.. _`unordered`:
**unordered**
Specifies how to treat events with one emission that does not respect
FKL ordering. The possible values are the same as for the `FKL`_
setting, but :code:`reweight` may not be supported for all process
types.
.. TODO: rename to non-HEJ
.. _`non-FKL`:
**non-FKL**
Specifies how to treat events where no resummation is possible. The
allowed values are :code:`keep` to keep the events as they are up to
a possible change of renormalisation and factorisation scale and
:code:`discard` to discard these events.
.. _`scales`:
**scales**
Specifies the renormalisation and factorisation scales for the output
events. This can either be a single entry or a list :code:`[scale1,
scale2, ...]`. For the case of a list the first entry defines the
central scale. Possible values are fixed numbers to set the scale in
GeV or the following:
- :code:`H_T`: The sum of the scalar transverse momenta of all
final-state particles
- :code:`max jet pperp`: The maximum transverse momentum of all jets
- :code:`jet invariant mass`: Sum of the invariant masses of all jets
- :code:`m_j1j2`: Invariant mass between the two hardest jets.
Scales can be multiplied or divided by an overall factor,
e.g. :code:`H_T/2`.
It is also possible to import scales from an external library, see
:ref:`Custom scales`
.. _`scale factors`:
**scale factors**
A list of numeric factors by which each of the `scales`_ should be
multiplied. Renormalisation and factorisation scales are varied
independently. For example, a list with entries :code:`[0.5, 2]`
would give the four scale choices (0.5μ\ :sub:`r`, 0.5μ\ :sub:`f`);
(0.5μ\ :sub:`r`, 2μ\ :sub:`f`); (2μ\ :sub:`r`, 0.5μ\ :sub:`f`); (2μ\
:sub:`r`, 2μ\ :sub:`f`) in this order. The ordering corresponds to
the order of the final event weights.
.. _`max scale ratio`:
**max scale ratio**
Specifies the maximum factor by which renormalisation and
factorisation scales may difer. For a value of :code:`2` and the
example given for the `scale factors`_ the scale choices
(0.5μ\ :sub:`r`, 2μ\ :sub:`f`) and (2μ\ :sub:`r`, 0.5μ\ :sub:`f`)
will be discarded.
.. _`log correction`:
**log correction**
Whether to include corrections due to the evolution of the strong
coupling constant in the virtual corrections. Allowed values are
:code:`true` and :code:`false`.
.. TODO: unweight
.. _`event output`:
**event output**
Specifies the name of a single event output file or a list of such
files. The file format is either specified explicitly or derived from
the suffix. For example, :code:`events.lhe` or, equivalently
:code:`Les Houches: events.lhe` generates an output event file
:code:`events.lhe` in the Les Houches format. The supported formats
are
- :code:`file.lhe` or :code:`Les Houches: file`: The Les Houches
event file format.
- :code:`file.hepmc` or :code:`HepMC: file`: The HepMC format.
-.. _`RanLux init`:
+.. _`random generator`:
-**RanLux init**
- Specifies a file to be loaded for the initialisation of the RanLux64
- random number generation. See the `CLHEP documentation
- <http://proj-clhep.web.cern.ch/proj-clhep/index.html#docu>`_ for
- details.
+**random generator**
+ Sets parameters for random number generation.
+
+ .. _`random generator: name`:
+
+ **name**
+ Which random number generator to use. Currently, :code:`mixmax`
+ and :code:`ranlux64` are implemented. Mixmax is recommended. See
+ the `CLHEP documentation
+ <http://proj-clhep.web.cern.ch/proj-clhep/index.html#docu>`_ for
+ details on the generators.
+
+ .. _`random generator: seed`:
+
+ **seed**
+ The seed for random generation. This should be a single number for
+ mixmax and the name of a state file for ranlux64.
.. _`analysis`:
**analysis**
Specifies the name and settings for a custom analysis library. The
:code:`plugin` sub-entry should be set to the analysis file path. All
further entries are passed on to the analysis. See
:ref:`Writing custom analyses` for details.
.. _`Higgs coupling`:
**Higgs coupling**
This collects a number of settings concerning the effective coupling
of the Higgs boson to gluons. This is only relevant for the
production process of a Higgs boson with jets and only supported if
reversed HEJ was compiled with `QCDloop
<https://github.com/scarrazza/qcdloop>`_ support.
.. _`Higgs coupling: use impact factors`:
**use impact factors**
Whether to use impact factors for the coupling to the most forward
and most backward partons. Impact factors imply the infinite
top-quark mass limit.
.. _`Higgs coupling: mt`:
**mt**
The value of the top-quark mass in GeV. If this is not specified,
the limit of an infinite mass is taken.
.. _`Higgs coupling: include bottom`:
**include bottom**
Whether to include the Higgs coupling to bottom quarks.
.. _`Higgs coupling: mb`:
**mb**
The value of the bottom-quark mass in GeV.

File Metadata

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

Event Timeline