emodpy_malaria.interventions.sugartrap module¶
-
emodpy_malaria.interventions.sugartrap.
SugarTrap
(campaign, start_day: int = 0, killing_effect: float = 1, insecticide: str = None, box_duration: int = 100, decay_rate: float = 0, expiration_constant: int = 100, node_ids=None)¶ Create a new SugarTrap scheduled campaign intervention. Note: for WaningEffect, Decay_Time_Constant = 1.0/decay_rate. box_duration = 0 + decay_rate > 0 => WaningEffectExponential box_duration > 0 + decay_rate = 0 => WaningEffectBox/Constant (depending on duration) box_duration > 0 + decay_rate > 0 => WaningEffectBoxExponential
- Parameters
campaign – campaign builder.
start_day – the day to distribute the SpaceSpraying intervention
killing_effect – portion of vectors killed by the intervention (Initial_Effect in WaningEffect)
insecticide – insecticide, if used
box_duration – Box_Duration of the WaningEffect
decay_rate – decay_rate of the WaningEffect, gets set as Decay_Time_Constant = 1.0/decay_rate
node_ids – list of node ids to which distribute the intervention
expiration_constant – how long after distribution of intervention it gets discarded
- Returns
The formatted intervention ready to be added to the campaign.
-
emodpy_malaria.interventions.sugartrap.
new_intervention_as_file
(campaign, start_day: int = 0, filename: str = None)¶ Create new campaign file with a single event which distributes a SugarTrap intervention mostly with defaults. Useful for sanity testing and first time users. :param campaign: campaign builder. :param start_day: the day to distribute the SpaceSpraying intervention :param filename: name of the filename created
- Returns
Filename of the file created.