log2Report.generateReport.writeReport

writeReport(outDir, reportDictList, reportOneFile, plotDict='', standaloneReport=False, reportName='fullSimulationReport')

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

• reportOneFile (boolean) – True to write all info in the same file

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

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

• reportName (str) – report file name, fullSimulationReport is the default value