Update to pythi8.170
[u/mrichter/AliRoot.git] / PYTHIA8 / pythia8170 / xmldoc / RIVETusage.xml
1 <chapter name="RIVET usage">
2
3 <h2>RIVET usage</h2>
4
5 <a href="http://projects.hepforge.org/rivet/">RIVET</a> is a toolkit for
6 the validation of Monte Carlo event generators <ref>Buc10</ref>. It
7 contains the results of many experimental analyses, so that generator
8 output can easily be compared to data, as well as providing a framework to
9 implement your own analyses.  Although using PYTHIA with RIVET is not
10 officially supported, some helpful hints are given below. The full RIVET
11 manual is available <a href="http://arxiv.org/abs/1003.0694">online</a>.
12
13 <br/><br/>
14 <h3>Using PYTHIA with RIVET</h3>
15 The following assumes that you already have RIVET installed. Instructions
16 for this may be found
17 <a href="http://projects.hepforge.org/rivet/trac/wiki/GettingStarted">
18 here</a>.
19
20 <br/><br/>
21 Events are passed from PYTHIA to RIVET using the HepMC format. PYTHIA must
22 be compiled with HepMC support, using the same version of HepMC used when
23 compiling RIVET. This is setup through the PYTHIA <code>configure</code>
24 script e.g.
25 <pre>
26   ./configure --with-hepmc=/path/to/HepMC --with-hepmcversion=HepMC.version.number
27 </pre>
28 The PYTHIA library itself does not need to be recompiled.
29
30 <br/><br/>
31 The <code>examples/main42.cc</code> sample program can then be used to
32 generate events in HepMC format (which <code>examples/main61.cc</code> 
33 and <code>examples/main62.cc</code> extends by allowing LHAPDF usage 
34 and subruns). When in the <code>examples</code> directory, the main program 
35 can be built and used as follows
36 <pre>
37   make main42
38   ./main42 main42.cmnd main42.hepmc
39 </pre>
40 The first argument is the input file which provides the options for event
41 generation, while the second is the output file where the HepMC events
42 should be written.
43
44 <br/><br/>
45 This HepMC file may now be read and processed by RIVET
46 <pre>
47   rivet --analysis=ANALYSIS_NAME main42.hepmc
48 </pre>
49 where <code>ANALYSIS_NAME</code> is a 
50 <a href="http://projects.hepforge.org/rivet/analyses">built-in RIVET
51 analysis</a>, or one you have created yourself. The output of RIVET is in
52 the form of <code>.aida</code> files, containing the histograms for the
53 analysis, which can be processed further with RIVET (see the
54 <a href="http://projects.hepforge.org/rivet/trac/wiki/FirstRivetRun">
55 RIVET documentation</a> for more details).
56
57 <br/><br/>
58 The above examples requires that (potentially large) HepMC events are stored
59 to disk before being read by RIVET. It is possible, instead, to pass the
60 events directly to RIVET as they are produced by using a <code>FIFO</code>
61 pipe. This is done with the <code>mkfifo</code> command
62 <pre>
63   mkfifo my_fifo
64   ./main42.exe main42.cmnd my_fifo &
65   rivet --analysis=ANALYSIS_NAME my_fifo
66 </pre>
67 Note that <code>main42</code> is run in the background.
68
69 </chapter>
70
71 <!-- Copyright (C) 2012 Torbjorn Sjostrand -->