pyPenred’s API

pyPenred.plotResults(simObj, tallyName: str, prefix: str = '', titles: list = [], fontSize: int = 20, labelPad: int = 20, width: int = 12, height: int = 9, markerSize: int = 6, capSize: int = 5, aspect: str = 'auto', vrange: list = [], erange: list = [], grid: bool = False, show: bool = False)

Read and plot the results from a simulation object with a finished simulation. This function requires the matplotlib module, which will be installed in the system if it is not.

Parameters:

• tallyName (str)

• prefix (str)

• titles (list)

• fontSize (int)

• labelPad (int)

• width (int)

• height (int)

• markerSize (int)

• capSize (int)

• aspect (str)

• vrange (list)

• erange (list)

• grid (bool)

• show (bool)

pyPenred.readConfigFile(filename)

Read a configuration file in both, YAML or penRed internal format, and returns the associated dictionary.

pyPenred.runFromFile(configFile='config.in', statusTime=20, configLog='config.log', simulationLog='simulation.log')

Configures and runs a simulation from the specified file. Reports the simulation status periodically.

pyPenred.writeConfigFile(filename, d)

Write a configuration file in penRed internal format, from the data stored in the dictionary.

Contents:

• Simulation Module
  • configFile2YAML()
  • create
  • dict2SectionString()
  • errorMessage()
  • setConfigurationLog()
  • setSimulationLog()
  • simulator
  • Materials Sub-Module
  • X-Ray Sub-Module
• PSF Module
  • psf2ascii()
  • psfSpectre()