demo#

class demo(preset=None, to_plot=None, scens=None, run_args=None, plot_args=None, **kwargs)[source]#

Shortcut for cv.Sim().run().plot().

Parameters:

  • preset (str) – use a preset run configuration; currently the only option is “full”

  • to_plot (str) – what to plot

  • scens (dict) – dictionary of scenarios to run as a multisim, if preset=’full’

  • kwargs (dict) – passed to Sim()

  • run_args (dict) – passed to sim.run()

  • plot_args (dict) – passed to sim.plot()

Examples:

cv.demo() # Simplest example
cv.demo('full') # Full example
cv.demo('full', overview=True) # Plot all results
cv.demo(beta=0.020, run_args={'verbose':0}, plot_args={'to_plot':'overview'}) # Pass in custom values