Difference between revisions of "Calculate section"

From HEPMDB
Jump to: navigation, search
m (Running)
(The calculation part)
 
(21 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
== The interface ==
 
== The interface ==
The interface is divided in four parts:
+
The interface is divided into four parts:
# the upper bar, with general menus,
+
# The top bar, containing the HEPMDB logo, the <tt>Show Iridis4 Queue</tt> and <tt>Go to Main Site</tt> buttons, and a drop down menu.
# the lower frame, with general information on the last operations,
+
# The messages box, with general information on the last operations.
# the left menu, with the main functions and the program list,
+
# The left menu, with the main functions and the program list.
# the main part, presenting results of computation.
+
# The calculation part, presenting results of computation.
  
=== The upper menu ===
+
=== The top bar ===
In the upper menu, you will find:
+
In the top bar, you will find:
* A help button,
+
* A <tt> Show Iridis4 Queue </tt> button that opens a window showing information on the total use of Iridis4 and the job queue for HEPMDB itself.
* The <tt>Go to HEPMDB</tt> button which brings you back to the <tt>HEPMDB</tt> main page,
+
* A drop down menu.
* The actual menu.
+
* The <tt>Go to Main Site</tt> button which redirects you to the <tt>HEPMDB</tt> main page in the same tab.
  
Most of the menu commands are straight forward, although a selection have been explained in more detail here.
 
* <tt>Remove models</tt>: it removes all models that were imported. When a model has been updated, it is necessary to remove the old version this way. There is no option to remove models individually.
 
* <tt>Reset model list and clear results</tt>: This will reset everything to its default state. No results will be kept. You should make sure you have downloaded any results you need to keep before doing this.
 
* <tt>Show queue on HPCx</tt>: as <tt>HEPMDB</tt> is a shared resource, when you asked for a job, it is put in the queue. This button displays the whole queue.
 
  
=== The lower frame ===
+
The drop down menu contains a few useful items:
The lower frame displays information about the most recent commands. The result of any command will be displayed here, except the computations themselves.
+
* <tt>User ID</tt>: This is very useful to reference if ever asking one of the developers about a problem with your account.
 +
* <tt>Documentation</tt>: This takes you to these Wiki pages in a new tab.
 +
* <tt>History</tt>: This opens a window with a full list of everything you have done on HEPMDB.
 +
* <tt>Send a message to admin</tt>: This opens a window allowing you to send a message to an admin with your registered email.
 +
* <tt>Reset Account</tt>: This will clear all your imported models and your .lhe and .nt files, and restore your account to its default settings.
  
When something has been queued, it is necessary to refresh the display explicitly (through the <tt>Check submitted jobs</tt> button).
+
=== The messages box ===
 +
This part of the webpage displays information on any actions you have performed. For example, starting a job will display a message stating whether or not the job has been successfully submitted and the time of submission. The <tt>Check Job Progress</tt> button, located in the menus of CalcHEP, Whizard and Madgraph, will display any information on currently running jobs (like expected completion time) in the message box also.
  
 
=== The left menu ===
 
=== The left menu ===
This is one of the most important menus in <tt>HEPMDB</tt>. The menu is divided in three panels. Each panel correspond to a specific program for computing matrix elements. <tt>CalcHEP</tt> and <tt>WHIZARD</tt> work essentially the same way. There are some subtle differences for <tt>MadGraph</tt>.
+
This is one of the most important menus in <tt>HEPMDB</tt>. This is where the commands to prepare, run and view the result files of a process are stored. The menu is divided into three panels. Each panel corresponds to a specific program for computing matrix elements. <tt>CalcHEP</tt> and <tt>WHIZARD</tt> work essentially the same way. There are some subtle differences for <tt>MadGraph</tt>.
  
=== The main part ===
+
=== The calculation part ===
When the computation is done, the results will be displayed here. In case of an error, the debugging information is also displayed here.
+
When the computation is done, the results will be displayed here. In the case of an error, the debugging information is also displayed here.
  
== Using <tt>CalcHEP</tt> ==
+
== Using <b><tt>CalcHEP</tt></b> ==
 
Here, we will review the basic steps for a <tt>CalcHEP</tt> computation.  
 
Here, we will review the basic steps for a <tt>CalcHEP</tt> computation.  
  
You can find a complete tutorial specifically for <tt>CalcHEP</tt> [[CalcHEP tutorial|HERE]].
+
You can find a complete tutorial specifically for <tt>CalcHEP</tt> <b>[[CalcHEP tutorial|HERE]]</b>.
  
 
=== Choosing a model ===
 
=== Choosing a model ===
When using <tt>CalcHEP</tt>, you first thing you have to do is make sure that the model you wish to use is imported. If it is imported, you will see it in the left panel. If it is not there, click on the <tt>Import model</tt> option of the <tt>CalcHEP</tt> drop-down menu. You can import any model uploaded to <tt>HEPMDB</tt> including any you have uploaded previously.
+
When using <tt>CalcHEP</tt>, the first thing you have to do is make sure that the model you wish to use is imported. If it is imported, you will see it in the left panel. If it is not there, click on the <tt>Import model</tt> option of the <tt>File</tt> drop-down menu. You can import any model that has been uploaded to <tt>HEPMDB</tt> and shared publicly, or any you have uploaded and not shared.
  
When your model is imported (when you can see it in the left panel) choose it by selecting it. You are now ready to work with that model.
+
When the model you wish to use is imported (when you can see it in the left panel) choose it by selecting it. You are now ready to work with that model.
  
 
=== The batch file ===
 
=== The batch file ===
On <tt>HEPMDB</tt>, you use the batch mode of <tt>CalcHEP</tt>. The batch file can be edited through the <tt>Edit full batch file</tt> option.
+
On <tt>HEPMDB</tt>, you use the batch mode of <tt>CalcHEP</tt>. The batch file can be edited through the <tt>Edit batch file</tt> option in the <tt>Selection</tt> drop down menu.
  
 
Besides writing the batch, you have four options in the editing window:
 
Besides writing the batch, you have four options in the editing window:
# <tt>Load batch template</tt>: this is a very useful option which loads the template file. The template file contains every possible option as well as some commented out sections which describe various parts of the batch file. Simply change the variables/values so that it calculates what you require and save it.
+
# <tt>Save Changes</tt>: This does not save to a file! Instead, it tells <tt>HEPMDB</tt> to use the written batch file for computation.
# <tt>Load from</tt>: this allows the user to load the batch file from a file.
+
# <tt>Import Full Template</tt>: This is a very useful option which loads the template file. The template file contains every possible option as well as some commented out sections which describe various parts of the batch file. Simply change the variables/values so that it calculates what you require and save it.
# <tt>Save</tt>: this does not save to a file! Instead, it tells <tt>HEPMDB</tt> to use the written batch file for computation.
+
# <tt>Load Batch</tt>: This allows the user to load the batch file from a file.
# <tt>Save As</tt>: this only saves to a file. You still have to use the <tt>Save</tt> button to tell <tt>HEPMDB</tt> to use the batch file.
+
# <tt>Save As</tt>: This option saves the current batch to a file. You still have to use the <tt>Save Changes</tt> button to tell <tt>HEPMDB</tt> to use the batch file.
  
 
=== Running ===
 
=== Running ===
When your batch file is ready, you can queue the process thanks to the <tt>Run Full Batch File</tt> button. You can check the status of the queued process via <tt>Check submitted job</tt>. When the computation is done, results will be displayed in the central panel. If not, use the <tt>Check submitted job</tt> button.
+
Once you have saved your batch file (making sure to have used the <tt>Save Changes</tt> button), you can now select <tt>Run Batch File</tt> from the <tt>Selection</tt> drop-down menu. You can check the status of the queued process via <tt>Check Job Progress</tt> in the <tt>File</tt> menu.
Previous results can been found using the history option from the CalcHEP or Menu drop down.  
 
  
If the job time set by the user is under 2 hours, the calculation will be given priority on HEPMDB.
+
When you select <tt>Run Batch File</tt> a window should appear asking you to confirm the job submission. In this window it is possible to change the requested HPCx usage time (the current default is 10 minutes). Asking for a smaller amount of time will give your job a higher priority. However, it is important to note that if your job is still running at the end of the requested time it will be killed and returned to you with anything it managed in that time. Users are also limited to a request of 60 hours maximum.
 +
 
 +
When the computation is done <tt>HEPMDB</tt> will notify you by email. When you receive this email you can return to the <tt>Calculate Section</tt> of <tt>HEPMDB</tt> to view your results. If your results are not automatically displayed click again on the <tt>Check Job Progress</tt> button and they should be now be displayed in the main window. Any previous results can been reviewed using the history option found in the <tt>Tools</tt> menu.
  
== Using <tt>WHIZARD</tt> ==
+
== Using <b><tt>WHIZARD</tt></b> ==
 
This only covers basic help. More comprehensive help is to come.
 
This only covers basic help. More comprehensive help is to come.
  
Line 67: Line 69:
  
 
Besides writing the batch, you have four options in the editing window:
 
Besides writing the batch, you have four options in the editing window:
# <tt>Load batch template</tt>: this is a very useful option loading a template file that contains every possible option. Then, change the variables/values to suit your calculation.
+
# <tt>Load batch template</tt>: This is very useful as it loads a template file that contains every possible option. You then change the variables/values to suit your calculation.
# <tt>Load from</tt>: this enable you to load a batch file from a file.
+
# <tt>Load from</tt>: This enables you to load a batch file from a file.
# <tt>Save</tt>: this does not save to a file! But it tells <tt>HEPMDB</tt> to use the written batch file for computation.
+
# <tt>Save</tt>: This does not save to a file! But it tells <tt>HEPMDB</tt> to use the written batch file for computation.
# <tt>Save As</tt>: this only saves to a file. You still have to use the <tt>Save</tt> button to tell <tt>HEPMDB</tt> to use the batch file.
+
# <tt>Save As</tt>: This only saves to a file. You still have to use the <tt>Save</tt> button to tell <tt>HEPMDB</tt> to use the batch file.
  
 
=== Running ===
 
=== Running ===
Push the <tt>Run Whizard</tt> option to run <tt>WHIZARD</tt>. You then have the choice between queuing or not. It is recommended that you choose to queue the calculation, especially for long computation as that allows you to close your internet browser while it is running.
+
To run <tt>WHIZARD</tt>, select the <tt>Run Whizard</tt> option. You then have the choice between queuing or not. It is recommended that you choose to queue the calculation, especially for long computation as that allows you to close your internet browser while it is running.
  
 
If the job time set by the user is under 2 hours, the calculation will be given priority on HEPMDB.
 
If the job time set by the user is under 2 hours, the calculation will be given priority on HEPMDB.
  
== Using <tt>MadGraph</tt> ==
+
== Using <b><tt>MadGraph</tt></b> ==
 
<tt>MadGraph</tt> works slightly differently. Once again, more comprehensive help should be available soon.
 
<tt>MadGraph</tt> works slightly differently. Once again, more comprehensive help should be available soon.
 
If the help you require is not available here, please search for <tt>MadGraph</tt> specific help on the internet.
 
If the help you require is not available here, please search for <tt>MadGraph</tt> specific help on the internet.
Line 83: Line 85:
 
=== <tt>MadGraph</tt> cards ===
 
=== <tt>MadGraph</tt> cards ===
 
<tt>MadGraph</tt> works with ''cards''. There are four different cards each having a particular role:
 
<tt>MadGraph</tt> works with ''cards''. There are four different cards each having a particular role:
# <tt>proc_card_mg5.dat</tt>: this defines the processes to be processed.
+
# <tt>proc_card_mg5.dat</tt>: This defines the processes to be processed.
 
# <tt>param_card.dat</tt>: This holds the parameters about the model (decays, branching ratios). Note that this file is overwritten by <tt>MadGraph</tt> after event generation.
 
# <tt>param_card.dat</tt>: This holds the parameters about the model (decays, branching ratios). Note that this file is overwritten by <tt>MadGraph</tt> after event generation.
# <tt>run_card.dat</tt>: in this file, you define the parameters for the run, for example the energy of the beam or which pdf to use.
+
# <tt>run_card.dat</tt>: In this file, you define the parameters for the run, for example the energy of the beam or which pdf to use.
 
# <tt>plot_card.dat</tt>: With <tt>MadGraph</tt> it is possible to automatically produce some plots. But with the <tt>HEPMDB</tt> toolkit and lhe file, this is of little use.
 
# <tt>plot_card.dat</tt>: With <tt>MadGraph</tt> it is possible to automatically produce some plots. But with the <tt>HEPMDB</tt> toolkit and lhe file, this is of little use.
  

Latest revision as of 13:19, 28 July 2015

The Calculate section of HEPMDB is accessible only if you are registered. This wiki page will enable you to use the HEPMDB computation frame in order to produce events and compute cross-sections using the various models on the website.

The interface

The interface is divided into four parts:

  1. The top bar, containing the HEPMDB logo, the Show Iridis4 Queue and Go to Main Site buttons, and a drop down menu.
  2. The messages box, with general information on the last operations.
  3. The left menu, with the main functions and the program list.
  4. The calculation part, presenting results of computation.

The top bar

In the top bar, you will find:

  • A Show Iridis4 Queue button that opens a window showing information on the total use of Iridis4 and the job queue for HEPMDB itself.
  • A drop down menu.
  • The Go to Main Site button which redirects you to the HEPMDB main page in the same tab.


The drop down menu contains a few useful items:

  • User ID: This is very useful to reference if ever asking one of the developers about a problem with your account.
  • Documentation: This takes you to these Wiki pages in a new tab.
  • History: This opens a window with a full list of everything you have done on HEPMDB.
  • Send a message to admin: This opens a window allowing you to send a message to an admin with your registered email.
  • Reset Account: This will clear all your imported models and your .lhe and .nt files, and restore your account to its default settings.

The messages box

This part of the webpage displays information on any actions you have performed. For example, starting a job will display a message stating whether or not the job has been successfully submitted and the time of submission. The Check Job Progress button, located in the menus of CalcHEP, Whizard and Madgraph, will display any information on currently running jobs (like expected completion time) in the message box also.

The left menu

This is one of the most important menus in HEPMDB. This is where the commands to prepare, run and view the result files of a process are stored. The menu is divided into three panels. Each panel corresponds to a specific program for computing matrix elements. CalcHEP and WHIZARD work essentially the same way. There are some subtle differences for MadGraph.

The calculation part

When the computation is done, the results will be displayed here. In the case of an error, the debugging information is also displayed here.

Using CalcHEP

Here, we will review the basic steps for a CalcHEP computation.

You can find a complete tutorial specifically for CalcHEP HERE.

Choosing a model

When using CalcHEP, the first thing you have to do is make sure that the model you wish to use is imported. If it is imported, you will see it in the left panel. If it is not there, click on the Import model option of the File drop-down menu. You can import any model that has been uploaded to HEPMDB and shared publicly, or any you have uploaded and not shared.

When the model you wish to use is imported (when you can see it in the left panel) choose it by selecting it. You are now ready to work with that model.

The batch file

On HEPMDB, you use the batch mode of CalcHEP. The batch file can be edited through the Edit batch file option in the Selection drop down menu.

Besides writing the batch, you have four options in the editing window:

  1. Save Changes: This does not save to a file! Instead, it tells HEPMDB to use the written batch file for computation.
  2. Import Full Template: This is a very useful option which loads the template file. The template file contains every possible option as well as some commented out sections which describe various parts of the batch file. Simply change the variables/values so that it calculates what you require and save it.
  3. Load Batch: This allows the user to load the batch file from a file.
  4. Save As: This option saves the current batch to a file. You still have to use the Save Changes button to tell HEPMDB to use the batch file.

Running

Once you have saved your batch file (making sure to have used the Save Changes button), you can now select Run Batch File from the Selection drop-down menu. You can check the status of the queued process via Check Job Progress in the File menu.

When you select Run Batch File a window should appear asking you to confirm the job submission. In this window it is possible to change the requested HPCx usage time (the current default is 10 minutes). Asking for a smaller amount of time will give your job a higher priority. However, it is important to note that if your job is still running at the end of the requested time it will be killed and returned to you with anything it managed in that time. Users are also limited to a request of 60 hours maximum.

When the computation is done HEPMDB will notify you by email. When you receive this email you can return to the Calculate Section of HEPMDB to view your results. If your results are not automatically displayed click again on the Check Job Progress button and they should be now be displayed in the main window. Any previous results can been reviewed using the history option found in the Tools menu.

Using WHIZARD

This only covers basic help. More comprehensive help is to come.

Choosing a model

On HEPMDB, WHIZARD usage is very similar to CalcHEP's. You first have to import a model and choose it. Note that the WHIZARD models available to use are a lot less numerous than those on CalcHEP. Please upload your own models if you need to. You can import the model via the Import model button then select it in the list in order to use it.

The batch file

The batch file can be edited through the Edit batch file option.

Besides writing the batch, you have four options in the editing window:

  1. Load batch template: This is very useful as it loads a template file that contains every possible option. You then change the variables/values to suit your calculation.
  2. Load from: This enables you to load a batch file from a file.
  3. Save: This does not save to a file! But it tells HEPMDB to use the written batch file for computation.
  4. Save As: This only saves to a file. You still have to use the Save button to tell HEPMDB to use the batch file.

Running

To run WHIZARD, select the Run Whizard option. You then have the choice between queuing or not. It is recommended that you choose to queue the calculation, especially for long computation as that allows you to close your internet browser while it is running.

If the job time set by the user is under 2 hours, the calculation will be given priority on HEPMDB.

Using MadGraph

MadGraph works slightly differently. Once again, more comprehensive help should be available soon. If the help you require is not available here, please search for MadGraph specific help on the internet.

MadGraph cards

MadGraph works with cards. There are four different cards each having a particular role:

  1. proc_card_mg5.dat: This defines the processes to be processed.
  2. param_card.dat: This holds the parameters about the model (decays, branching ratios). Note that this file is overwritten by MadGraph after event generation.
  3. run_card.dat: In this file, you define the parameters for the run, for example the energy of the beam or which pdf to use.
  4. plot_card.dat: With MadGraph it is possible to automatically produce some plots. But with the HEPMDB toolkit and lhe file, this is of little use.

For all of these files, templates are available, so you do not have to know every parameter. Filling these files and checking the different parameters should be enough in most cases.

Running

For running, just use the Run Madgraph button. For now, there is no queuing system for MadGraph so you must stay connected to HEPMDB website while computing.

If the job time set by the user is under 2 hours, the calculation will be given priority on HEPMDB.