emodpy_malaria.interventions.larvicide module#
- emodpy_malaria.interventions.larvicide.add_larvicide(campaign, start_day: int = 1, num_repetitions: int = 0, timesteps_between_reps: int = 365, spray_coverage: float = 1.0, killing_effect: float = 1, habitat_target: str = 'ALL_HABITATS', insecticide: str = None, box_duration: int = 100, decay_time_constant: float = 0.0, node_ids: list = None, intervention_name: str = 'Larvicides', cost_to_consumer: float = 0, node_property_restrictions: dict = None)[source]#
Create a new Larvicides scheduled campaign intervention.
Note: for killing effects - depending on the parameters you set, different WaningEffect classes will be used: box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential box_duration > 0 + decay_time_constant = 0 => WaningEffectBox box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential
- Args:
campaign: start_day: the day to distribute the Larvicides intervention num_repetitions: Optional number of repetitions. timesteps_between_reps: Gap between repetitions, if num_reptitions specified. spray_coverage: how much of each node to cover (total portion killed = killing effect * coverage) killing_effect: portion of vectors killed by the intervention (Initial_Effect in WaningEffect) habitat_target: E.g., (TBD) box_duration: Box_Duration of the WaningEffect decay_time_constant: decay_time_constant of the WaningEffect node_ids: list of node ids to which distribute the intervention insecticide: name of the insecticide defined in <config.Insecticides> for this intervention intervention_name: name of the intervention cost_to_consumer: Per unit cost when distributed node_property_restrictions: dict of node property restrictions
- Returns:
The formatted intervention ready to be added to the campaign.
- emodpy_malaria.interventions.larvicide.new_intervention_as_file(campaign, start_day: int = 1, filename: str = None)[source]#
Creates a file with Larvicides intervention Args:
campaign: start_day: the day to distribute the Larvicides intervention filename: name of the filename created
Returns: filename of the file created