demo#

demo(run=True, plot=True, summary=True, show=True, **kwargs)[source]#

Create a simple demo simulation for Starsim

Defaults to using the SIR model with a random network, but these can be configured.

Parameters:

  • run (bool) – whether to run the sim

  • plot (bool) – whether to plot the results

  • summary (bool) – whether to print a summary of the results

  • kwargs (dict) – passed to ss.Sim()

Examples:

ss.demo() # Run, plot, and show results
ss.demo(diseases='hiv', networks='mf') # Run with different defaults