BaseVaccination#

class BaseVaccination(*args, product=None, prob=None, label=None, **kwargs)[source]#

Bases: Intervention

Base vaccination class for determining who will receive a vaccine.

Parameters:
  • product (str/Product) – the vaccine to use

  • prob (float/arr) – annual probability of eligible population getting vaccinated

  • eligibility (inds/callable) – indices OR callable that returns inds

  • label (str) – the name of vaccination strategy

  • kwargs (dict) – passed to Intervention()

Attributes

now

Return the current time, i.e. the time vector at the current timestep.

states

Return a flat list of all states

statesdict

Return a flat dictionary (objdict) of all states

Methods

step()[source]#

Deliver the diagnostics by finding who’s eligible, finding who accepts, and applying the product.