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

Run the SLIC Geant4 simulation. More...

Inheritance diagram for SLIC:
Component

Public Member Functions

 __init__ (self, **kwargs)
 
 cmd_args (self)
 Setup command arguments.
 
 config (self, parser)
 Configure SLIC component.
 
 setup (self)
 Setup SLIC component.
 
 optional_parameters (self)
 Return list of optional parameters.
 
 required_parameters (self)
 Return list of required parameters.
 
 required_config (self)
 Return list of required configurations.
 
 execute (self, log_out, log_err)
 Execute SLIC component.
 
- 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.
 
 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters.
 
 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.
 
 output_files (self)
 Return a list of output files created by 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

 macros
 List of macros to run (optional)
 
 run_number
 Run number to set on output file (optional)
 
 detector_dir
 To be set from config or install dir.
 
 disable_particle_table
 Optionally disable loading of the particle table shipped with slic Note: This should not be used with a General Particle Source since the GPS in slic requires the particle table to function.
 
 seed
 
 nevents
 
 detector
 
 slic_dir
 
 env_script
 
 name
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Private Member Functions

 __detector_file (self)
 Return path to detector file.
 
 __particle_tbl (self)
 Return path to particle table.
 

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

Run the SLIC Geant4 simulation.

Optional parameters are: nevents, macros, run_number, disable_particle_table
Required parameters are: detector
Required configurations are: slic_dir, detector_dir

Definition at line 15 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
**  kwargs 
)

Reimplemented from Component.

Definition at line 24 of file tools.py.

Member Function Documentation

◆ __detector_file()

__detector_file (   self)
private

Return path to detector file.

Definition at line 81 of file tools.py.

◆ __particle_tbl()

__particle_tbl (   self)
private

Return path to particle table.

Definition at line 85 of file tools.py.

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Definition at line 42 of file tools.py.

◆ config()

config (   self,
  parser 
)

Configure SLIC component.

Reimplemented from Component.

Definition at line 89 of file tools.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute SLIC component.

Component is executed by creating command line input from command and command arguments.

Returns
return code of process

Reimplemented from Component.

Definition at line 141 of file tools.py.

◆ optional_parameters()

optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: nevents, macros, run_number

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 114 of file tools.py.

◆ required_config()

required_config (   self)

Return list of required configurations.

Required configurations are: slic_dir, detector_dir

Returns
list of required configurations

Reimplemented from Component.

Definition at line 132 of file tools.py.

◆ required_parameters()

required_parameters (   self)

Return list of required parameters.

Required parameters are: detector

Returns
list of required parameters

Reimplemented from Component.

Definition at line 123 of file tools.py.

◆ setup()

setup (   self)

Setup SLIC component.

Reimplemented from Component.

Definition at line 99 of file tools.py.

Member Data Documentation

◆ detector

detector

Definition at line 83 of file tools.py.

◆ detector_dir

detector_dir

To be set from config or install dir.

Definition at line 30 of file tools.py.

◆ disable_particle_table

disable_particle_table

Optionally disable loading of the particle table shipped with slic Note: This should not be used with a General Particle Source since the GPS in slic requires the particle table to function.

Definition at line 34 of file tools.py.

◆ env_script

env_script

Definition at line 104 of file tools.py.

◆ macros

macros

List of macros to run (optional)

Definition at line 26 of file tools.py.

◆ name

name

Definition at line 106 of file tools.py.

◆ nevents

nevents

Definition at line 56 of file tools.py.

◆ run_number

run_number

Run number to set on output file (optional)

Definition at line 28 of file tools.py.

◆ seed

seed

Definition at line 53 of file tools.py.

◆ slic_dir

slic_dir

Definition at line 87 of file tools.py.


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