Package madgraph :: Package interface :: Module tutorial_text
[hide private]
[frames] | no frames]

Source Code for Module madgraph.interface.tutorial_text

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