HPS-MC
MG Class Reference

Abstract class for MadGraph generators. More...

Inheritance diagram for MG:
EventGenerator Component MG4 MG5

Public Member Functions

def __init__ (self, name, **kwargs)
 
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...
 
def execute (self, log_out, log_err)
 Execute MadGraph generator. More...
 
def setup (self)
 Setup event generator. More...
 
- Public Member Functions inherited from EventGenerator
def __init__ (self, name, command=None, **kwargs)
 
def get_install_dir (self)
 
- 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

 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
 

Detailed Description

Abstract class for MadGraph generators.

Required parameters are: nevents, run_params
Optional parameters are: seed, param_card, apmass, map, mpid, mrhod

Definition at line 179 of file generators.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
**  kwargs 
)

Reimplemented in MG5, and MG4.

Definition at line 187 of file generators.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Return command arguments.

Reimplemented from Component.

Definition at line 303 of file generators.py.

◆ execute()

def execute (   self,
  log_out,
  log_err 
)

Execute MadGraph generator.

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

Reimplemented from Component.

Reimplemented in MG5, and MG4.

Definition at line 307 of file generators.py.

◆ make_param_card()

def make_param_card (   self,
  param_card 
)

Make parameter card.

Definition at line 275 of file generators.py.

◆ make_run_card()

def make_run_card (   self,
  run_card 
)

Make run card.

Definition at line 256 of file generators.py.

◆ optional_parameters()

def optional_parameters (   self)

Return optional parameters.

Optional parameters are: seed, param_card, apmass, map, mpid, mrhod, Map, mchi, dmchi

Reimplemented from Component.

Definition at line 245 of file generators.py.

◆ output_files()

def output_files (   self)

Generate output file name.

Reimplemented from Component.

Definition at line 222 of file generators.py.

◆ required_parameters()

def required_parameters (   self)

Return required parameters.

Required parameters are: nevents, run_params

Reimplemented from EventGenerator.

Definition at line 237 of file generators.py.

◆ set_parameters()

def set_parameters (   self,
  params 
)

Set parameters.

Reimplemented from Component.

Definition at line 231 of file generators.py.

◆ setup()

def setup (   self)

Setup event generator.

Reimplemented from Component.

Reimplemented in MG5, and MG4.

Definition at line 317 of file generators.py.

Member Data Documentation

◆ apmass

apmass

A-prime mass.

Note
map and Map are also A' masses

Definition at line 200 of file generators.py.

◆ dmchi

dmchi

difference between dark fermion masses when running idm

Definition at line 212 of file generators.py.

◆ event_types

event_types

event types: weighted or unweighted

Definition at line 216 of file generators.py.

◆ madgraph_dir

madgraph_dir

Install dir or user config will be used for this.

Definition at line 190 of file generators.py.

◆ map

map

A-prime mass.

Note
apmass and Map are also A' masses

Definition at line 202 of file generators.py.

◆ Map

Map

A-prime mass.

Note
apmass and map are also A' masses

Definition at line 204 of file generators.py.

◆ mchi

mchi

average dark fermion mass when running idm

Definition at line 210 of file generators.py.

◆ mpid

mpid

dark pion mass

Definition at line 206 of file generators.py.

◆ mrhod

mrhod

dark rho mass

Definition at line 208 of file generators.py.

◆ name

name

Definition at line 325 of file generators.py.

◆ param_card

param_card

Default name of param card.

Definition at line 193 of file generators.py.

◆ run_card

run_card

Definition at line 234 of file generators.py.


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