pymchelper.executor.options module

class pymchelper.executor.options.FlukaEnvironment

Bases: pymchelper.executor.options.MCEnvironment

FLUKA Environment

executable_filename = 'rfluka'

class pymchelper.executor.options.MCEnvironment

Bases: object

MCEnvironment subclasses are helpful to discover which MC engine (i.e. FLUKA or SHIELD-HIT12A) is being used they provide information about expected executable filename, by inspecting the path to executable filename (i.e. checking if it ends with rfluka) we can find corresponding code type

executable_filename = None

class pymchelper.executor.options.SH12AEnvironmentLinux

Bases: pymchelper.executor.options.MCEnvironment

SHIELD-HIT12A Environment for Linux

executable_filename = 'shieldhit'

class pymchelper.executor.options.SH12AEnvironmentWindows

Bases: pymchelper.executor.options.MCEnvironment

SHIELD-HIT12A Environment for Windows

executable_filename = 'shieldhit.exe'

class pymchelper.executor.options.SH12ASettings(input_path, simulator_exec_path=None, cmdline_opts=None)

Bases: pymchelper.executor.options.SimulationSettings

TODO

class pymchelper.executor.options.SimulationSettings(input_path, simulator_exec_path=None, cmdline_opts=None)

Bases: object

This class is responsible for keeping track of options for MC simulation:

• location of the MC simulator executable
• additional options provided by the user
• location of the input files or directories

Moreover this class performs automatic discovery of the MC input (i.e. whether this is SHIELD-HIT12A input or FLUKA input)

set_no_of_primaries(number_of_primaries)

This methods modifies command line options of the MC engine by setting (or overriding) the number of primaries to be simulated by each of the parallel jobs TODO this method is specific to SH12A, more general should be added TODO add support for no of primaries provided as –nstat, instead of -n

set_rng_seed(rng_seed)

This methods modifies command line options of the MC engine by setting (or overriding) the value of RNG seed TODO this method is specific to SH12A, more general should be added TODO add support for RNG seed provided as –seedofset, instead of -N