API

Input

PENELOPE

• description – Description of a simulation
• distribution – Angular, energy and spatial distributions
• hook – Hook to pre-process and/or post-process the options
• hooks – Common hooks for PENELOPE
• io – Input/Output for PENELOPE options
• jobproperties – Properties of the simulation job
• materials – Material data and simulation parameters
• option – Base option class for all options
• options – Base PENELOPE options
• parameter – Parameter for batch simulation
• particle – Definition of the type of particles
• source – Options for the incident particle source
• util – Utilities for input modules
• io – Input/Output methods for any PENELOPE programs

PENGEOM

• geometry – Geometry definition for PENGEOM
• usergeometry – Base class for all user geometries
• grainboundaries – Grain boundaries geometry
• inclusion – Spherical inclusion geometry
• multilayers – Multi-layers geometry
• substrate – Substrate geometry
• util – Utilities for user geometries
• util – Utilities for reading and writing GEO files

PENEPMA

• hooks – Common hooks for PENEPMA
• interactionforcings – Interaction forcings
• io – Input/Output for PENEPMA options
• maximumsteplengths – Maximum step length parameters
• options – Options for PENEPMA simulation
• photondetectors – Photon detectors
• hooks – Common hooks for PENEPMA2010
• io – Input/Output for PENEPMA2010 options
• jobproperties – Properties of the simulation job
• options – Options for PENEPMA2010 simulation
• source – Options for the incident particle source
• hooks – Common hooks for PENEPMA2011
• io – Input/Output for PENEPMA2011 options
• jobproperties – Properties of the simulation job
• options – Options for PENEPMA2011 simulation
• phirhozs – Phi-rho-z distributions

SHOWER

• hooks – Common hooks for SHOWER2010
• io – Input/Output for SHOWER2010 options
• jobproperties – Properties of the simulation job
• options – Options for SHOWER2010 simulation

Program/Runner

• program – Base program class
• material – Program to create material file(s)
• penepma – Program to launch PENEPMA simulation
• penslab – Program to launch PENSLAB simulation
• shower – Program to launch SHOWER simulation
• runner – Base runner classes
• hook – Base hook to perform task before and after a run
• penepma – Runner for all PENEPMA simulations
• shower – Runner for SHOWER simulation
• simulation – Build and execute automatically many PENELOPE simulations
• util – Utilities for the runners

Results

• result – Base result classes to read results from PENELOPE simulations
• penepma – All the results from a PENEPMA and PENEPMA2010 simulation
• distribution – Results of the electron and photon distribution
• log – Log results from a simulation
• photonspectra – Results of the photon spectra collected by the detectors
• util – Utilities for PENEPMA results
• penepma2011 – All the results from a PENEPMA2011 simulation
• bremsstrahlung – Probability of emission of bremsstrahlung photons
• intensity – Photon intensities (detected and generated)
• phirhoz – Phi-rho-z distributions
• shower2010 – All the results from a SHOWER2010 simulation
• distribution – Electron trajectories in the shower

Figures

• figure – Base figure classes to create figures from PENELOPE simulations
• penepma – All the figures from a PENEPMA and PENEPMA2010 simulation
• distribution – Figures of the electron and photon distribution
• photonspectra – Figures of the photon spectra collected by the detectors
• penepma – All the figures from a PENEPMA2011 simulation
• phirhoz – Figures for phi-rho-z distributions
• shower2010 – All the figures from a SHOWER2010 simulation
• distribution – Figures from the electron distribution in the shower
• styles – Matplotlib styles for the PENELOPE figures

Utilities

• multipleloop – Loop around many parameters
• xraytransition – X-ray transitions information