HPS-MC
 
Loading...
Searching...
No Matches
MG Class Reference

Abstract class for MadGraph generators. More...

Inheritance diagram for MG:
EventGenerator Component MG4 MG5

Public Member Functions

 __init__ (self, name, **kwargs)
 
 output_files (self)
 Generate output file name.
 
 set_parameters (self, params)
 Set parameters.
 
 required_parameters (self)
 Return required parameters.
 
 optional_parameters (self)
 Return optional parameters.
 
 make_run_card (self, run_card)
 Make run card.
 
 make_param_card (self, param_card)
 Make parameter card.
 
 cmd_args (self)
 Return command arguments.
 
 execute (self, log_out, log_err)
 Execute MadGraph generator.
 
 setup (self)
 Setup event generator.
 
- Public Member Functions inherited from EventGenerator
 get_install_dir (self)
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 cmd_exists (self)
 Check if the component's assigned command exists.
 
 cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings.
 
 cleanup (self)
 Perform post-job cleanup such as deleting temporary files.
 
 config_logging (self, parser)
 Configure the logging for a component.
 
 config (self, parser)
 Automatic configuration.
 
 required_config (self)
 Return a list of required configuration settings.
 
 check_config (self)
 Raise an exception on the first missing config setting for this component.
 
 input_files (self)
 Get a list of input files for this component.
 
 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.
 

Public Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from Component
 _inputs_to_outputs (self)
 This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided.
 

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__()

__init__ (   self,
  name,
**  kwargs 
)

Reimplemented from EventGenerator.

Reimplemented in MG4, and MG5.

Definition at line 187 of file generators.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Return command arguments.

Reimplemented from Component.

Definition at line 305 of file generators.py.

◆ execute()

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 MG4, and MG5.

Definition at line 309 of file generators.py.

◆ make_param_card()

make_param_card (   self,
  param_card 
)

Make parameter card.

Definition at line 275 of file generators.py.

◆ make_run_card()

make_run_card (   self,
  run_card 
)

Make run card.

Definition at line 256 of file generators.py.

◆ optional_parameters()

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()

output_files (   self)

Generate output file name.

Reimplemented from Component.

Definition at line 222 of file generators.py.

◆ required_parameters()

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()

set_parameters (   self,
  params 
)

Set parameters.

Reimplemented from Component.

Definition at line 231 of file generators.py.

◆ setup()

setup (   self)

Setup event generator.

Reimplemented from Component.

Reimplemented in MG4, and MG5.

Definition at line 322 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.

◆ command

command

Definition at line 315 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 319 of file generators.py.

◆ nevents

nevents
Todo:
explain what run card is

Definition at line 259 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.

◆ seed

seed
Todo:
explain what run card is

Definition at line 259 of file generators.py.


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