← Back to branch summary

~maddevelopers/mg5amcnlo/WWW5_caching

« back to all changes in this revision

Viewing changes to users/mardelcourt/PROC_129738/PROC_129738/README

  • Committer: John Doe
  • Date: 2013-03-25 20:27:02 UTC
  • Revision ID: john.doe@gmail.com-20130325202702-5sk3t1r8h33ca4p4
first clean version

Show diffs side-by-side

added added

removed removed

Lines of Context:
users/mardelcourt/PROC_129738/PROC_129738/README
 
1
MadGraph/MadEvent 5
 
2
By Johan Alwall, Michel Herquet, Fabio Maltoni, Olivier Mattelaer and Tim Stelzer
 
3
 
 
4
http://madgraph.phys.ucl.ac.be/
 
5
http://madgraph.hep.uiuc.edu/
 
6
 
 
7
Information on the process to be generated is found in the file
 
8
index.html in this directory, which should be viewed using your web
 
9
browser. If the file index.html is missing, you need to generate a
 
10
process. Please refer to the README file one directory above this
 
11
(MadGraph5_vx_x_x/) for instructions on how to generate a process.
 
12
 
 
13
This README includes information on how 
 
14
A) generate events
 
15
B) how to run in cluster/multi-core mode
 
16
C) how to launch sequential run (called multi-run)
 
17
D) How to launch Pythia/PGS/Delphes
 
18
E) How to prevent automatic opening of html pages
 
19
 
 
20
A) To generate events:
 
21
-------------------
 
22
 
 
23
1) Specify the model parameters. The model parameters include masses
 
24
and widths for the particles and coupling constants. They are given by
 
25
the file param_card.dat in the Cards directory. Although it is
 
26
possible to edit this file manually, this is not recommended since
 
27
there are dependencies among the parameters which need to be taken
 
28
into account. Instead the param_card.dat should be generated using one
 
29
of the Calculators found on the MG/ME homepages (stated above).  Click
 
30
Calculators, choose model and follow the instructions. Place the
 
31
resulting param_card.dat in the Cards directory.
 
32
 
 
33
2) Specify the run parameters. The run parameters includes collider
 
34
type and energy, choice of parton distribution functions and scales.
 
35
They are given by the file run_card.dat in the Cards directory. This
 
36
file should be edited manually, following the syntax given in the
 
37
example file.
 
38
**Warning!** For several reasons, avoid running more than 100,000
 
39
events per run. Instead perform several runs to reach the luminosity
 
40
you need, e.g. using the multi_run describe below. Subsequent runs
 
41
automatically update the random seed, so the results from different
 
42
runs are statistically independent.
 
43
 
 
44
3) Run bin/generate_events to generate the events and calculate the
 
45
cross-section.
 
46
 
 
47
4) Follow the generation and look at the results in the file
 
48
HTML/crossx.html, using your web browser.
 
49
 
 
50
5) If you want to run Pythia and/or PGS/Delphes on the events.
 
51
You first need to install it. For this launch MG5 ($MG5PATH/bin/mg5)
 
52
and type `install pythia-pgs`/ `install Delphes`.
 
53
If they are detected, the first question asked when launching ./bin/generate_events
 
54
should be something like:
 
55
Which programs do you want to run?
 
56
  0 / auto    : running existing card
 
57
  1 / parton  :  Madevent
 
58
  2 / pythia  : MadEvent + Pythia.
 
59
  3 / pgs     : MadEvent + Pythia + PGS.
 
60
 [0, 1, 2, 3, auto, parton, pythia, pgs][20s to answer] 
 
61
if this is not that means that you need to specify the path of the new program
 
62
in the file Cards/me5_configuration.txt . By default they are 
 
63
installed in the MG5 directory.
 
64
 
 
65
If you need to run one of those programs on some events which are already generated
 
66
please see instructions below.
 
67
 
 
68
 
 
69
B) Running in cluster or multicore mode:
 
70
----------------------------------------
 
71
 
 
72
In order to automatically run in cluster or multicore mode, please set
 
73
the flag run_mode in the Cards/me5_configuration.txt file (or in the
 
74
input/mg5_configuration.txt file before you generate your process):
 
75
 
 
76
# Default Running mode 
 
77
# 0: single machine/ 1: cluster / 2: multicore
 
78
run_mode = 0
 
79
 
 
80
You can also specify the cluster type (for cluster mode) or your
 
81
preferred number of CPUs (for multicore mode - note that by default,
 
82
the maximum number of cores is used) by setting cluster_type and
 
83
nb_core.
 
84
 
 
85
 
 
86
C) Launch sequential runs for generation of large number of events:
 
87
-------------------------------------------------------------------
 
88
 
 
89
For various reason, we recommend not to generate more than 100k events
 
90
per run. In order to simplify generating large numbers of events,
 
91
we have created a special command 'multi_run', which is equivalent to
 
92
running generate_events multiple times (ensuring that the random seed is
 
93
different for each run), and also automatically combines the resulting
 
94
lhe files into a single file.
 
95
This command can be launched via the madevent user interface
 
96
./bin/madevent using the following command:
 
97
multi_run NBRUN [RUN_NAME] [options]
 
98
For more information about this command (valid options), you can type
 
99
`help multi_run` inside the interface.
 
100
 
 
101
Note that you can also launch a command whithout entering the interactive mode:
 
102
./bin/madevent multi_run NBRUN 
 
103
 
 
104
 
 
105
D) Launching pythia/pgs/delphes on a (previously) generated sample:
 
106
-------------------------------------------------------------------
 
107
 
 
108
In this section, I will presupose that the corresponding package is
 
109
already installed and configured properly. (See section how to generate 
 
110
events if this is not the case)
 
111
 
 
112
In order to launch pythia/pgs/delphes on a sample, you need first to
 
113
launch the interactive session of madevent `./bin/madevent`
 
114
and then you can enter of the following command
 
115
pythia RUN [--run_options]
 
116
pgs RUN [--run_options]
 
117
delphes RUN [--run_options]
 
118
where RUN is the run_name of the run. One of the convenient options is
 
119
--tag=XXXX
 
120
which allow to specify the tag name in case of multiple runs with
 
121
the same program. Note that by default, a unique run tag is generated 
 
122
for each time you run.
 
123
 
 
124
E) How to prevent automatic opening of the crossx.html page:
 
125
------------------------------------------------------------
 
126
 
 
127
Edit the file ./Cards/me5_configuration.txt and set
 
128
the option automatic_html_opening to `False`.
 
129
You can also edit the MG5 configuration card
 
130
input/mg5_configuration.txt
 
131
in order to have this value on False by default for all subsequently 
 
132
generated processes.
 
133
 
 
134