log2Report.generateCompareReport.writeCompareReport

writeCompareReport(reportFile, reportD, benchD, avaName, cfgRep)[source]

Write a report in markdown format of the comparison of simulations to reference simulation results; report is saved to location of reportFile

Parameters
  • reportFile (str) – path to report file

  • reportD (dict) – report dictionary with simulation info

  • benchD (str) – dictionary with simulation info of refernce simulation

  • avaName (str) – name of avalanche

  • cfgRep (dict) – dictionary with configuration info