emodpy_malaria.interventions.outdoor_node_emanator module#

This module contains functionality for OutdoorNodeEmanator intervention for malaria campaigns

emodpy_malaria.interventions.outdoor_node_emanator.add_outdoor_node_emanator_scheduled(campaign, killing_initial_effect: float, killing_box_duration: float, killing_decay_time_constant: float, repelling_initial_effect: float, repelling_box_duration: float, repelling_decay_time_constant: float, start_day: int, spray_coverage: float = 1.0, node_ids: list | None = None, repetitions: int = 1, timesteps_between_repetitions: int = 365, node_property_restrictions: list | None = None, receiving_broadcast_event: str | None = None, insecticide: str = '', cost: float = 0, new_property_value: str = '', intervention_name: str = 'OutdoorNodeEmanator')[source]#

Add a scheduled OutdoorNodeEmanator intervention.

Parameters:

  • campaign – object for building, modifying, and writing campaign configuration files.

  • start_day – The day the intervention is given out.

  • node_ids – List of node ids representing nodes to target with the intervention. [] or None indicates all nodes will be targeted.

  • repetitions – The number of times an intervention is given, used with timesteps_between_repetitions. -1 means the intervention repeats forever. Sets Number_Repetitions

  • timesteps_between_repetitions – The interval, in timesteps, between repetitions. Ignored if repetitions = 1. Sets Timesteps_Between_Repetitions.

  • node_property_restrictions – A list of dictionaries of NodeProperties, which are needed for the node to receive the intervention. Sets the Node_Property_Restrictions.

  • receiving_broadcast_event – Optional. BroadcastNodeEvent that’s sent out when OutdoorNodeEmanator is received.

  • killing_initial_effect – Initial strength of the Killing effect. The effect may decay over time.

  • killing_box_duration – Box duration of effect in days before the decay of Killing Initial_Effect.

  • killing_decay_time_constant – The exponential decay length, in days of the Killing Initial_Effect.

  • repelling_initial_effect – Initial strength of the Repelling effect. The effect may decay over time.

  • repelling_box_duration – Box duration of effect in days before the decay of Repelling Initial_Effect.

  • repelling_decay_time_constant – The exponential decay length, in days of the Repelling Initial_Effect.

  • insecticide – The name of the insecticide defined in config.Insecticides for this intervention. If insecticides are being used, then this must be defined as one of those values. If they are not being used, then this does not needed to be specified or can be empty string. It cannot have a value if config.Insecticides does not define anything.

  • cost – Unit cost per OutdoorNodeEmanator

  • new_property_value – New NodeProperty value to assign to nodes receiving this intervention. Must be in format of “PropertyName:Value”, e.g. “EmanatorNode:Yes”.

  • intervention_name – The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.

Returns:

Nothing