oceanval.compare#
- oceanval.compare(model_dict=None, view=True, ask=True, pdf=False, word=False)[source]#
Compare pre-validated simulations. This function will compare the validation output from multiple simulations.
- Parameters:
model_dict (dict) – A dictionary mapping model names to the paths of their validation outputs.
view (bool) – Open the comparison report in a web browser after it is generated.
ask (bool) – If the comparison directory already exists, ask before replacing it.
pdf (bool) – Whether to also generate PDF downloads of the report. Default is False.
word (bool) – Whether to also generate Word versions of the report (one per page, plus a combined oceanval_report.docx), with the maths as editable Word equations. Default is False. Requires pandoc.