pyPenred’s API

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