log2Report.generateReport.writeReport

writeReport(outDir, reportDictList, cfgFLAGS, plotDict='', standaloneReport=False)[source]

Write a report in markdown format for simulations, saved to outDir

Parameters

  • outDir (str) – path to output directory

  • reportDictList (list) – list of report dictionaries from simulations

  • cfgFLAGS (dict) – configuration dictionary

  • plotDict (dict) – optional dictionary with info on plots that shall be included in report

  • standaloneReport (bool) – if True copy plots to reportDir