change_initiation#
- class change_initiation(years=None, eligibility=None, perc=0.0, annual=True, force_theoretical=False, **kwargs)[source]#
Bases:
InterventionIntervention that modifies the outcomes of whether women are on contraception or not Select a proportion of women and sets them on a contraception method.
- Parameters:
years (list, float) – The year we want to start the intervention. if years is None, uses start and end years of sim as defaults if years is a number or a list with a single lem,ent, eg, 2000.5, or [2000.5], this is interpreted as the start year of the intervention, and the end year of intervention will be the eno of the simulation
eligibility (callable) – callable that returns a filtered version of people eligible to receive the intervention
perc (float) –
a value between 0 and 1 indicating the x% extra of women who will be made to select a contraception method . The proportion or % is with respect to the number of women who were on contraception:
the previous year (12 months earlier)?
at the beginning of the intervention.
annual (bool) – whether the increase, perc, represents a “per year” increase.
Attributes
auto_state_listList of "automatic" states with boolean type (ss.BoolState) that were added via define_states()
dtGet the current module timestep
has_productCheck if the intervention has a product
nowShortcut to self.t.now()
state_dictReturn a flat dictionary (objdict) of all states
state_listReturn a flat list of all states (ss.Arr objects)
tiGet the current module timestep
timevecShortcut to self.t.timevec
Methods