Scenarios

class Scenarios(pars=None, repeats=None, scens=None, **kwargs)

Bases: prettyobj

Run different intervention scenarios.

A “scenario” can be thought of as a list of sims, all with the same parameters except for the random seed. Usually, scenarios differ from each other only in terms of the interventions run (to compare other differences between sims, it’s preferable to use a MultiSim object).

Parameters:

• pars (dict) – parameters to pass to the sim

• repeats (int) – how many repeats of each scenario to run (default: 1)

• scens (list) – the list of scenarios to run; see also fp.make_scen() and Scenarios.add_scen()

• kwargs (dict) – optional additional parameters to pass to the sim

Example:

scen1 = fp.make_scen(label='Baseline')
scen2 = fp.make_scen(year=2002, eff={'Injectables':0.99}) # Basic efficacy scenario
scens = fp.Scenarios(location='test', repeats=2, scens=[scen1, scen2])
scens.run()

Methods

add_scen(scen=None, label=None)

Add a scenario or scenarios to the Scenarios object

make_sims(scenlabel, **kwargs)

Create a list of sims that are all identical except for the random seed

make_scens()

Convert a scenario specification into a list of sims

run(recompute=True, *args, **kwargs)

Actually run a list of sims

check_run()

Give a meaningful error message if the scenarios haven’t been run

plot(to_plot=None, plot_sims=True, **kwargs)

Plot the scenarios with bands – see sim.plot() for args

plot_sims(to_plot=None, plot_sims=True, **kwargs)

Plot each sim as a separate line across all senarios – see sim.plot() for args

analyze_sims(start=None, end=None)

Take a list of sims that have different labels and extrapolate statistics from each