← Back to branch summary

~maddevelopers/mg5amcnlo/2.9.4

« back to all changes in this revision

Viewing changes to madgraph/interface/tutorial_text.py

pass to v2.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
madgraph/interface/tutorial_text.py
1
1
################################################################################
2
2
#
3
 
# Copyright (c) 2009 The MadGraph Development team and Contributors
 
3
# Copyright (c) 2009 The MadGraph5_aMC@NLO Development team and Contributors
4
4
#
5
 
# This file is a part of the MadGraph 5 project, an application which 
 
5
# This file is a part of the MadGraph5_aMC@NLO project, an application which 
6
6
# automatically generates Feynman diagrams and matrix elements for arbitrary
7
7
# high-energy processes in the Standard Model and beyond.
8
8
#
9
 
# It is subject to the MadGraph license which should accompany this 
 
9
# It is subject to the MadGraph5_aMC@NLO license which should accompany this 
10
10
# distribution.
11
11
#
12
 
# For more information, please visit: http://madgraph.phys.ucl.ac.be
 
12
# For more information, visit madgraph.phys.ucl.ac.be and amcatnlo.web.cern.ch
13
13
#
14
14
################################################################################
15
15
 
16
16
tutorial = """
17
17
You have entered tutorial mode. This will introduce you to the main
18
 
syntax options of MadGraph5.
 
18
syntax options of MadGraph5_aMC@NLO.
19
19
 
20
20
To learn more about the different options for a command, you can use
21
 
mg5>help A_CMD
 
21
MG5_aMC>help A_CMD
22
22
To see a list of all commands, use
23
 
mg5>help 
 
23
MG5_aMC>help 
24
24
 
25
25
The goal of this tutorial is to learn how to generate a process and to
26
26
produce the output for MadEvent. In this part we will learn
29
29
c) How to run the MadEvent output
30
30
 
31
31
Let's start with the first point, how to generate a process:
32
 
mg5>generate p p > t t~
 
32
MG5_aMC>generate p p > t t~
33
33
Note that a space is mandatory between the particle names.
34
34
"""
35
35
 
38
38
Note that the coupling order \"QED=0\" was automatically added by MG5
39
39
to avoid non-QCD diagrams which have negligible contribution.
40
40
You can find more information on supported syntax by using:
41
 
mg5>help generate
 
41
MG5_aMC>help generate
42
42
To list all defined processes, type
43
 
mg5>display processes
 
43
MG5_aMC>display processes
44
44
 
45
45
If you want to know more about particles and multiparticles present,
46
46
write
47
 
mg5>display particles
48
 
mg5>display multiparticles
 
47
MG5_aMC>display particles
 
48
MG5_aMC>display multiparticles
49
49
 
50
50
If you want to add a second process, use the add process command:
51
 
mg5>add process p p > W+ j, W+ > l+ vl @2
 
51
MG5_aMC>add process p p > W+ j, W+ > l+ vl @2
52
52
This adds a decay chain process, with the W+ decaying
53
53
leptonically.
54
54
 
55
55
At this stage you can export your processes to different formats. In
56
56
this tutorial, we will explain how to create output for MadEvent.
57
57
This is done simply by typing:
58
 
mg5>output MY_FIRST_MG5_RUN
 
58
MG5_aMC>output MY_FIRST_MG5_RUN
59
59
"""
60
60
 
61
61
display_processes = """
64
64
At this stage you can export your processes to different formats. In
65
65
this tutorial, we will explain how to create a valid output for
66
66
MadEvent. This is done simply by typing:
67
 
mg5>output MY_FIRST_MG5_RUN
 
67
MG5_aMC>output MY_FIRST_MG5_RUN
68
68
"""
69
69
 
70
70
add_process = """
73
73
At this stage you can export your processes to different formats. In
74
74
this tutorial, we will explain how to create output for MadEvent.
75
75
This is done simply by typing:
76
 
mg5>output MY_FIRST_MG5_RUN
 
76
MG5_aMC>output MY_FIRST_MG5_RUN
77
77
"""
78
78
output = """
79
79
If you are following the tutorial, a directory MY_FIRST_MG5_RUN has
83
83
Additionally to the MG4 command (see MY_FIRST_MG5_RUN/README), you can also 
84
84
generate your events/compute the cross-section from this interface:
85
85
Please Enter:
86
 
mg5> launch MY_FIRST_MG5_RUN
 
86
MG5_aMC> launch MY_FIRST_MG5_RUN
87
87
(you can interrupt the computation to continue the tutorial by pressing Ctrl-C)
88
88
"""
89
89
 
90
90
open_index = output
91
91
 
92
 
launch = """This step ends the tutorial of the basic commands of MG5. You can
 
92
launch = """This step ends the tutorial of the basic commands of MG5_aMC. You can
93
93
always use the help to see the options available for different
94
94
commands. For example, if you want to know all valid output formats,
95
95
you can enter
96
 
mg5>help output
 
96
MG5_aMC>help output
97
97
 
98
98
In order to close this tutorial please enter
99
 
mg5>tutorial stop
100
 
If you want to exit MG5 please enter
101
 
mg5>exit
 
99
MG5_aMC>tutorial stop
 
100
If you want to exit MG5_aMC please enter
 
101
MG5_aMC>exit
102
102
 
103
103
But you can also continue the tutorial to learn some other useful
104
104
commands:
105
105
d) How to load a model
106
106
e) How to define a multi-particle label 
107
107
f) How to store a history of the commands in a session
108
 
g) How to call shell commands from MG5
 
108
g) How to call shell commands from MG5_aMC
109
109
h) How to draw the diagrams for your processes without generating
110
110
   MadEvent output
111
111
 
112
112
To import a model, write:
113
 
mg5>import model mssm
 
113
MG5_aMC>import model mssm
114
114
"""
115
115
 
116
116
import_model ="""
119
119
 
120
120
If you want to know more information about this model you can use the
121
121
following commands:
122
 
mg5>display particles
123
 
mg5>display interactions
124
 
mg5>display multiparticles
 
122
MG5_aMC>display particles
 
123
MG5_aMC>display interactions
 
124
MG5_aMC>display multiparticles
125
125
which show information on the particles and the vertices of the model
126
126
or presently defined multiparticle labels.
127
127
 
128
128
Some of the model (including mssm) allow to modify the model (setting some
129
129
mass to zero, put some matrices diagonal, remove some interaction, ...). You can
130
130
see the possibility for each model by using the following command:
131
 
mg5> customize_model 
 
131
MG5_aMC> customize_model 
132
132
 
133
133
To define a multiparticle label, i.e. a label corresponding to a set
134
134
of particles, write:
135
 
mg5>define v = w+ w- z a
 
135
MG5_aMC>define v = w+ w- z a
136
136
This defines the symbol \"v\" to correspond to any EW vector boson.
137
137
"""
138
138
import_model_v4 = import_model
142
142
The model with your customization is now loaded and you can use it as any other
143
143
model. Note that if you want to save this specific customization you can do the
144
144
following:
145
 
mg5> customize_model --save=NAME
 
145
MG5_aMC> customize_model --save=NAME
146
146
the model will then be accessible by the command (assuming that you are based on mssm)
147
 
mg5> import model mssm-NAME
 
147
MG5_aMC> import model mssm-NAME
148
148
 
149
149
To define a multiparticle label, i.e. a label corresponding to a set
150
150
of particles, write:
151
 
mg5>define v = w+ w- z a
 
151
MG5_aMC>define v = w+ w- z a
152
152
This defines the symbol \"v\" to correspond to any EW vector boson.
153
153
"""
154
154
 
159
159
 
160
160
Note that some multiparticles such as as p, j, l+, l- are
161
161
predefined. Type
162
 
mg5>display multiparticles
 
162
MG5_aMC>display multiparticles
163
163
to see their definitions.
164
164
 
165
165
MG5 allows you to store a file with the list of command that you have
166
166
used in an interactive session:
167
 
mg5>history my_mg5_cmd.dat
 
167
MG5_aMC>history my_mg5_cmd.dat
168
168
"""
169
169
 
170
170
history = """
171
171
You have written a history file. If you followed the tutorial this
172
172
should be ./my_mg5_cmd.dat. In order to load a history file and
173
173
execute the commands in it, you can do:
174
 
mg5>import command my_mg5_cmd.dat
 
174
MG5_aMC>import command my_mg5_cmd.dat
175
175
or from the shell:
176
 
./bin/mg5 my_mg5_cmd.dat
 
176
./bin/mg5_aMC my_mg5_cmd.dat
177
177
 
178
 
It is also possible to display this file directly from MG5:
179
 
mg5>open ./my_mg5_cmd.dat
 
178
It is also possible to display this file directly from MG5_aMC:
 
179
MG5_aMC>open ./my_mg5_cmd.dat
180
180
"""
181
181
 
182
182
 
184
184
 
185
185
open = """
186
186
Note that in order to open some file, you might be need to use a shell command.
187
 
Any shell command can be launched by MG5, by running \"shell\" or
 
187
Any shell command can be launched by MG5_aMC, by running \"shell\" or
188
188
starting the line by an exclamation mark (!).
189
189
 
190
190
The final command of the tutorial is display diagrams. This allows you to draw and
192
192
creating an output for a given format. This can be useful for a fast
193
193
check of your process. For this last command, we will also show how combine
194
194
different command in a single line: 
195
 
mg5>generate p p > go go; display diagrams
 
195
MG5_aMC>generate p p > go go; display diagrams
196
196
 
197
197
Note that when you run output [madevent_v4], the diagrams are
198
198
automatically written to the matrix.ps files in subprocess
202
202
display_diagrams = """
203
203
This command was the last step of the tutorial. 
204
204
Quit the tutorial by typing:
205
 
mg5>tutorial stop
 
205
MG5_aMC>tutorial stop
206
206
 
207
 
Thanks for using MG5.
 
207
Thanks for using MadGraph5_aMC@NLO.
208
208
"""
209
209
 
210
210