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

Target processing and conversion of LHE files to StdHep using EGS5. More...

Inheritance diagram for StdHepConverter:
EGS5 EventGenerator Component

Public Member Functions

 __init__ (self, name="lhe_v1", **kwargs)
 
 config (self, parser)
 Automatic configuration.
 
 setup (self)
 Setup egs5 generator.
 
 execute (self, log_out, log_err)
 Execute converter.
 
 output_files (self)
 Converts *.lhe.gz and *.lhe to *.stdhep files.
 
- Public Member Functions inherited from EGS5
 get_install_dir (self)
 Get installation directory.
 
 required_parameters (self)
 Return required parameters.
 
 optional_parameters (self)
 Return optional parameters.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 cmd_exists (self)
 Check if the component's assigned command exists.
 
 cmd_args (self)
 Return the command arguments of this component.
 
 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.
 
 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters.
 
 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

 name
 
 inputs
 
- Public Attributes inherited from EGS5
 bunches
 
 target_thickness
 target thickness in $\mu$m,
 
 egs5_dir
 egs5 installation directory
 
 beam_energy
 beam energy in MeV
 
 num_electrons
 number of electrons
 
 egs5_data_dir
 data directory
 
 egs5_config_dir
 config directory
 
 target_dz
 
- 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

Target processing and conversion of LHE files to StdHep using EGS5.

Definition at line 135 of file generators.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  name = "lhe_v1",
**  kwargs 
)

Reimplemented from EGS5.

Definition at line 138 of file generators.py.

Member Function Documentation

◆ config()

config (   self,
  parser 
)

Automatic configuration.

Automatically load attributes from config by reading in values from the section with the same name as the class in the config file and assigning them to class attributes with the same name.

Parameters
parserconfig parser

Reimplemented from Component.

Definition at line 144 of file generators.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute converter.

Calls egs5 generator.

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

Reimplemented from EGS5.

Definition at line 154 of file generators.py.

◆ output_files()

output_files (   self)

Converts *.lhe.gz and *.lhe to *.stdhep files.

Reimplemented from EGS5.

Definition at line 174 of file generators.py.

◆ setup()

setup (   self)

Setup egs5 generator.

Throws exception if input LHE file is missing.

Reimplemented from EGS5.

Definition at line 147 of file generators.py.

Member Data Documentation

◆ inputs

inputs

Definition at line 151 of file generators.py.

◆ name

name

Definition at line 142 of file generators.py.


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