pyPENELOPE

penepma – Runner for all PENEPMA simulations

Inheritance diagram of penelopetools.api.runner.penepma

class penelopetools.api.runner.penepma.Penepma2010(config_filepath, options=None, results_dir=None)

Bases: penelopetools.api.runner.Runner

Runner for the 2010 release of PENEPMA. It extends the class Runner by tracking the progress of the simulation. The following quantities are tracked:

  • the number of showers simulated (progress_showers)
  • the elapsed time (progress_time)
  • the error on the characteristic X-ray line (progress_error)

The method update reads these values from the output of the simulation.

Parameters:
  • config_filepath – filepath to the configuration where the path to the PENEPMA2010 program and MATERIAL2010 program are specified
  • options (Options) – options of the simulation to be executed. The options are optional since they can be specified later via the attribute options
  • results_dir – directory where to save the results of the simulation. If it is not specified, the current directory is used.
options

Options of the simulation. The name of the thread is automatically set as the title of the simulation in the options.

class penelopetools.api.runner.penepma.Penepma2011(config_filepath, options=None, results_dir=None)

Bases: penelopetools.api.runner.Runner

Runner for the 2010 release of PENEPMA. It extends the class Runner by tracking the progress of the simulation. The following quantities are tracked:

  • the number of showers simulated (progress_showers)
  • the elapsed time (progress_time)
  • the error on the characteristic X-ray line (progress_error)

The method update reads these values from the output of the simulation.

Parameters:
  • config_filepath – filepath to the configuration where the path to the PENEPMA2010 program and MATERIAL2010 program are specified
  • options (Options) – options of the simulation to be executed. The options are optional since they can be specified later via the attribute options
  • results_dir – directory where to save the results of the simulation. If it is not specified, the current directory is used.
options

Options of the simulation. The name of the thread is automatically set as the title of the simulation in the options.