SLIC Class Reference

Run the SLIC Geant4 simulation. More...

Inheritance diagram for SLIC:

Public Member Functions
def	__init__ (self, **kwargs)
def	cmd_args (self)
	Setup command arguments. More...
def	config (self, parser)
	Configure SLIC component. More...
def	setup (self)
	Setup SLIC component. More...
def	optional_parameters (self)
	Return list of optional parameters. More...
def	required_parameters (self)
	Return list of required parameters. More...
def	required_config (self)
	Return list of required configurations. More...
def	execute (self, log_out, log_err)
	Execute SLIC component. More...
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	set_parameters (self, params)
	Set class attributes for the component based on JSON parameters. 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	output_files (self)
	Return a list of output files created by 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
	macros
	List of macros to run (optional) More...
	run_number
	Run number to set on output file (optional) More...
	detector_dir
	To be set from config or install dir. More...
	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. More...
	env_script
Public Attributes inherited from Component
	name
	command
	nevents
	seed
	inputs
	outputs
	append_tok
	output_ext
	ignore_job_params
	hpsmc_dir
	logger

Private Member Functions
def	__detector_file (self)
	Return path to detector file. More...
def	__particle_tbl (self)
	Return path to particle table. More...

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

def __init__	(		self,
		**	kwargs
	)

Definition at line 24 of file tools.py.

Member Function Documentation

__detector_file()

def __detector_file (   self )

private

Return path to detector file.

Definition at line 81 of file tools.py.

__particle_tbl()

def __particle_tbl (   self )

private

Return path to particle table.

Definition at line 85 of file tools.py.

cmd_args()

def cmd_args

(

self

)

Setup command arguments.

Returns

list of arguments

Reimplemented from Component.

Definition at line 42 of file tools.py.

config()

def config	(		self,
			parser
	)

Configure SLIC component.

Reimplemented from Component.

Definition at line 89 of file tools.py.

execute()

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

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

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

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

def setup

(

self

)

Setup SLIC component.

Reimplemented from Component.

Definition at line 99 of file tools.py.

Member Data Documentation

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.

run_number

run_number

Run number to set on output file (optional)

Definition at line 28 of file tools.py.

---

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

• python/hpsmc/tools.py