HPS-MC
MG5 Class Reference

Run the MadGraph 5 event generator. More...

Inheritance diagram for MG5:
MG EventGenerator Component

Public Member Functions

def __init__ (self, name='tritrig', **kwargs)
 
def get_install_dir (self)
 Get installation directory of MadGraph5. More...
 
def setup (self)
 Setup MadGraph5 generator. More...
 
def execute (self, log_out, log_err)
 Execute MadGraph5 generator. More...
 
- Public Member Functions inherited from MG
def output_files (self)
 Generate output file name. More...
 
def set_parameters (self, params)
 Set parameters. More...
 
def required_parameters (self)
 Return required parameters. More...
 
def optional_parameters (self)
 Return optional parameters. More...
 
def make_run_card (self, run_card)
 Make run card. More...
 
def make_param_card (self, param_card)
 Make parameter card. More...
 
def cmd_args (self)
 Return command arguments. More...
 
- Public Member Functions inherited from EventGenerator
def __init__ (self, name, command=None, **kwargs)
 
- Public Member Functions inherited from Component
def __init__ (self, name, command=None, nevents=None, seed=1, inputs=[], outputs=None, append_tok=None, output_ext=None, ignore_job_params=[], **kwargs)
 
def cmd_line_str (self)
 
def cmd_exists (self)
 Check if the component's assigned command exists. More...
 
def cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings. More...
 
def cleanup (self)
 Perform post-job cleanup such as deleting temporary files. More...
 
def config_logging (self, parser)
 Configure the logging for a component. More...
 
def config (self, parser)
 Automatic configuration. More...
 
def required_config (self)
 Return a list of required configuration settings. More...
 
def check_config (self)
 Raise an exception on the first missing config setting for this component. More...
 
def input_files (self)
 Get a list of input files for this component. More...
 
def config_from_environ (self)
 Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. More...
 

Public Attributes

 proc_dir
 
 event_dir
 
 command
 
- Public Attributes inherited from MG
 madgraph_dir
 Install dir or user config will be used for this. More...
 
 param_card
 Default name of param card. More...
 
 apmass
 A-prime mass. More...
 
 map
 A-prime mass. More...
 
 Map
 A-prime mass. More...
 
 mpid
 dark pion mass More...
 
 mrhod
 dark rho mass More...
 
 mchi
 average dark fermion mass when running idm More...
 
 dmchi
 difference between dark fermion masses when running idm More...
 
 event_types
 event types: weighted or unweighted More...
 
 run_card
 
 name
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Static Public Attributes

dictionary dir_map
 

Detailed Description

Run the MadGraph 5 event generator.

Definition at line 399 of file generators.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name = 'tritrig',
**  kwargs 
)

Reimplemented from MG.

Definition at line 411 of file generators.py.

Member Function Documentation

◆ execute()

def execute (   self,
  log_out,
  log_err 
)

Execute MadGraph5 generator.

Parameters
log_outname of log file for output
log_errname of log file for error
Returns
error code

Reimplemented from MG.

Definition at line 459 of file generators.py.

◆ get_install_dir()

def get_install_dir (   self)

Get installation directory of MadGraph5.

Reimplemented from EventGenerator.

Definition at line 418 of file generators.py.

◆ setup()

def setup (   self)

Setup MadGraph5 generator.

Reimplemented from MG.

Definition at line 422 of file generators.py.

Member Data Documentation

◆ command

command
Todo:
FIXME: This doesn't seem to work as generate_events doesn't read the input config.

Definition at line 442 of file generators.py.

◆ dir_map

dictionary dir_map
static
Initial value:
= {"BH": "BH",
"RAD": "RAD",
"tritrig": "tritrig",
"simp": "simp",
"simp-3body": "simp-3body",
"idm": "idm",
}
Todo:
: Put this information into a method in the MG superclass.

Definition at line 403 of file generators.py.

◆ event_dir

event_dir

Definition at line 427 of file generators.py.

◆ proc_dir

proc_dir

Definition at line 426 of file generators.py.


The documentation for this class was generated from the following file: