Skip to content

Comparison Reports

Brice Nichols edited this page Jul 8, 2021 · 4 revisions

The script scripts\summarize\standard\write_html.py converts notebooks to standard HTML reports. The script also produces the directory and results in outputs\compare through code embedded in the notebooks. These are produced for different levels of geography (e.g., county, regional_geography [rg], equity, etc.) within the notebooks x_summary_rtp.ipynb, for each geography type x.

These notebooks produce both HTML outputs and CSV files that summarize the results for the model run. These CSV files can then be accessed to produce comparison summaries for any run that has these same outputs (which should be available automatically when all summaries are produced).

To create comparison summaries, edit the file settings.py in scripts\summarize\notebooks.

  • Set run_comparison = True to generate the comparison HTMLs
  • Change comparison_dict to reflect the scenario name (dictionary keys on the left side of the colon) and the location of the runs (dictionary values on the right side of the colon). Any number of runs can be compared.
    • e.g.
    'Base' : r'\\modelstation3\c$\Workspace\sc_new_vot\soundcast',
    'Scenario 1': r'\\modelstation3\c$\Workspace\sc_new_vot_SCEN1_2018\soundcast',
    'Scenario 2': r'\\modelstation3\c$\Workspace\sc_new_vot_SCEN2_2018\soundcast'
    }
    
  • Run the following script from the project root folder to reproduce all HTMLs and the comparison HTMLs: python scripts\summarize\standard\write_html.py
  • The resulting HTML reports will be available in this run's directory outputs\compare
Clone this wiki locally