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) 2009 The MadGraph Development team and Contributors 
  4  # 
  5  # This file is a part of the MadGraph 5 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 MadGraph license which should accompany this  
 10  # distribution. 
 11  # 
 12  # For more information, please visit: http://madgraph.phys.ucl.ac.be 
 13  # 
 14  ################################################################################ 
 15   
 16  tutorial = """ 
 17  You have entered tutorial mode. This will introduce you to the main 
 18  syntax options of MadGraph5. 
 19   
 20  To learn more about the different options for a command, you can use 
 21  mg5>help A_CMD 
 22  To see a list of all commands, use 
 23  mg5>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>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>help generate 
 42  To list all defined processes, type 
 43  mg5>display processes 
 44   
 45  If you want to know more about particles and multiparticles present, 
 46  write 
 47  mg5>display particles 
 48  mg5>display multiparticles 
 49   
 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 
 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>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>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>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 run MadEvent exactly as if 
 81  it was coming from MG4. 
 82   
 83  Additionally to the MG4 command (see MY_FIRST_MG5_RUN/README), you can also  
 84  generate your events/compute the cross-section from this interface: 
 85  Please Enter: 
 86  mg5> launch MY_FIRST_MG5_RUN 
 87  (you can interrupt the computation to continue the tutorial by pressing Ctrl-C) 
 88  """ 
 89   
 90  open_index = output 
 91   
 92  launch = """This step ends the tutorial of the basic commands of MG5. You can 
 93  always use the help to see the options available for different 
 94  commands. For example, if you want to know all valid output formats, 
 95  you can enter 
 96  mg5>help output 
 97   
 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 
102   
103  But you can also continue the tutorial to learn some other useful 
104  commands: 
105  d) How to load a model 
106  e) How to define a multi-particle label  
107  f) How to store a history of the commands in a session 
108  g) How to call shell commands from MG5 
109  h) How to draw the diagrams for your processes without generating 
110     MadEvent output 
111   
112  To import a model, write: 
113  mg5>import model mssm 
114  """ 
115   
116  import_model =""" 
117  You have successfully imported a model. If you followed the tutorial 
118  this is the MSSM. 
119   
120  If you want to know more information about this model you can use the 
121  following commands: 
122  mg5>display particles 
123  mg5>display interactions 
124  mg5>display multiparticles 
125  which show information on the particles and the vertices of the model 
126  or presently defined multiparticle labels. 
127   
128  To define a multiparticle label, i.e. a label corresponding to a set 
129  of particles, write: 
130  mg5>define v = w+ w- z a 
131  This defines the symbol \"v\" to correspond to any EW vector boson. 
132  """ 
133  import_model_v4 = import_model 
134   
135  define = """ 
136  You have just defined a multiparticle label. 
137  If you followed the tutorial, the label is \"v\" 
138   
139  Note that some multiparticles such as as p, j, l+, l- are 
140  predefined. Type 
141  mg5>display multiparticles 
142  to see their definitions. 
143   
144  MG5 allows you to store a file with the list of command that you have 
145  used in an interactive session: 
146  mg5>history my_mg5_cmd.dat 
147  """ 
148   
149  history = """ 
150  You have written a history file. If you followed the tutorial this 
151  should be ./my_mg5_cmd.dat. In order to load a history file and 
152  execute the commands in it, you can do: 
153  mg5>import command my_mg5_cmd.dat 
154  or from the shell: 
155  ./bin/mg5 my_mg5_cmd.dat 
156   
157  It is also possible to display this file directly from MG5: 
158  mg5>open ./my_mg5_cmd.dat 
159  """ 
160   
161   
162  open_index = output 
163   
164  open = """ 
165  Note that in order to open some file, you might be need to use a shell command. 
166  Any shell command can be launched by MG5, by running \"shell\" or 
167  starting the line by an exclamation mark (!). 
168   
169  The final command of the tutorial is display diagrams. This allows you to draw and 
170  look at the diagrams for your processes (in eps format) before 
171  creating an output for a given format. This can be useful for a fast 
172  check of your process. For this last command, we will also show how combine 
173  different command in a single line:  
174  mg5>generate p p > go go; display diagrams 
175   
176  Note that when you run output [madevent_v4], the diagrams are 
177  automatically written to the matrix.ps files in subprocess 
178  directory, just like with MadGraph 4. 
179  """ 
180   
181  display_diagrams = """ 
182  This command was the last step of the tutorial.  
183  Quit the tutorial by typing: 
184  mg5>tutorial stop 
185   
186  Thanks for using MG5. 
187  """ 
188