decision_summary

site_solutions.SolutionComparator.decision_summary(
    matrix=None,
    demand=None,
    meaningful_change_threshold=0.0,
    config_a=None,
    config_b=None,
    worst_affected_n=3,
)

A single stakeholder-facing summary bundling everything a decision- maker needs to weigh set_b (the candidate) against set_a (the baseline): which sites close or open, how many people are better/ worse off and by how much, the specific places hit hardest, and how equitable the candidate network is on its own terms. Combines population_impact_phrase(), population_impact_worst_affected(), and the candidate’s own equity verdicts into one call, rather than assembling the pieces by hand as the example notebooks otherwise do.

Parameters

Name Type Description Default
matrix Passed straight through to population_impact_phrase() and population_impact_worst_affected(). None
demand Passed straight through to population_impact_phrase() and population_impact_worst_affected(). None
meaningful_change_threshold Passed straight through to population_impact_phrase() and population_impact_worst_affected(). None
config_a Passed straight through to population_impact_phrase() and population_impact_worst_affected(). None
config_b Passed straight through to population_impact_phrase() and population_impact_worst_affected(). None
worst_affected_n int Number of hardest-hit places to name (see population_impact_worst_affected(n=...)). Kept small since this is meant to read as a paragraph, not a table – call population_impact_worst_affected() directly for the full list. 3

Returns

Name Type Description
str A blank-line-separated, multi-paragraph summary: which sites close/open (or a note that none do); the population-impact phrase; the hardest-hit places by name, worsened by more than meaningful_change_threshold (omitted entirely if nothing worsened); and the candidate network’s own equity verdicts (best-vs-worst-group and most-vs-least-deprived-third), omitted if no equity data is registered.
Back to top