ivermectin

add_scheduled_ivermectin(campaign, start_day=1, demographic_coverage=1.0, target_num_individuals=None, node_ids=None, repetitions=1, target_age_min=0, target_age_max=MAX_AGE_YEARS, timesteps_between_repetitions=365, ind_property_restrictions=None, killing_initial_effect=1, killing_box_duration=30, killing_decay_time_constant=90, insecticide='', cost=1, intervention_name='Ivermectin', broadcast_event='Received_Ivermectin')

Adds a scheduled Ivermectin CampaignEvent to the campaign, which can be repeated any number of times. When a new Ivermectin intervention is given to an individual, if they already have an existing Ivermectin intervention, both interventions will be active. The efficacies of the two interventions will not be combined. There is no limit to how many Ivermectin interventions an individual can have active at one time.

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

Parameters:

Name	Type	Description	Default
campaign	EMODCampaign	A campaign builder that also contains schema_path parameters.	required
start_day	int	The day on which the intervention is distributed.	1
demographic_coverage	float	This value is the probability that each individual in the target population will receive the intervention. It does not guarantee that the exact fraction of the target population set by Demographic_Coverage receives the intervention.	1.0
target_num_individuals	int	The exact number of people to select out of the targeted group. If this value is set, demographic_coverage parameter is ignored.	None
node_ids	list	List of nodes to which to distribute the intervention. [] or None indicates all nodes will get the intervention.	None
repetitions	int	The number of times an intervention is given, used with timesteps_between_repetitions. -1 means the intervention repeats forever. Sets Number_Repetitions.	1
target_age_min	float	The lower end of ages targeted for an intervention, in years. Sets Target_Age_Min.	0
target_age_max	float	The upper end of ages targeted for an intervention, in years. Sets Target_Age_Max.	MAX_AGE_YEARS
timesteps_between_repetitions	int	The interval, in timesteps, between repetitions. Ignored if repetitions = 1. Sets Timesteps_Between_Repetitions.	365
ind_property_restrictions	list	A list of dictionaries of IndividualProperties, which are needed for the individual to receive the intervention. Sets the Property_Restrictions_Within_Node.	None
killing_initial_effect	float	Initial strength of the Killing effect. The effect may decay over time.	1
killing_box_duration	float	Box duration of effect in days before the decay of killing_initial_effect.	30
killing_decay_time_constant	float	The exponential decay length, in days of the killing_initial_effect.	90
insecticide	str	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 need to be specified or can be empty string. It cannot have a value if config.Insecticides does not define anything.	''
cost	float	Unit cost per Ivermectin dosing (unamortized).	1
intervention_name	str	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	'Ivermectin'
broadcast_event	str	An event to be broadcast when a person receives Ivermectin intervention. Default: "Received_Ivermectin". You can turn this off by passing in an empty string or None.	'Received_Ivermectin'

Source code in emodpy_malaria/interventions/ivermectin.py

def add_scheduled_ivermectin(campaign,
                             start_day: int = 1,
                             demographic_coverage: float = 1.0,
                             target_num_individuals: int = None,
                             node_ids: list = None,
                             repetitions: int = 1,
                             target_age_min: float = 0,
                             target_age_max: float = MAX_AGE_YEARS,
                             timesteps_between_repetitions: int = 365,
                             ind_property_restrictions: list = None,
                             killing_initial_effect: float = 1,
                             killing_box_duration: float = 30,
                             killing_decay_time_constant: float = 90,
                             insecticide: str = "",
                             cost: float = 1,
                             intervention_name: str = "Ivermectin",
                             broadcast_event: str = "Received_Ivermectin"
                             ):
    """
    Adds a scheduled **Ivermectin** **CampaignEvent** to the campaign, which can be repeated any number of times.
    When a new **Ivermectin** intervention is given to an individual, if they already have an existing **Ivermectin**
    intervention, both interventions will be active. The efficacies of the two interventions will not be combined.
    There is no limit to how many **Ivermectin** interventions an individual can have active at one time.

    For killing effects - depending on the parameters you set, different **WaningEffect** classes will be used:<br>
        • box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored<br>
        • box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential<br>
        • box_duration > 0 + decay_time_constant = 0 => WaningEffectBox<br>
        • box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential<br>

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): A campaign builder that also contains schema_path parameters.
        start_day (int): The day on which the intervention is distributed.
        demographic_coverage (float): This value is the probability that each individual in the target population will
            receive the intervention. It does not guarantee that the exact fraction of the target population set by
            **Demographic_Coverage** receives the intervention.
        target_num_individuals (int): The exact number of people to select out of the targeted group. If this value is set,
            **demographic_coverage** parameter is ignored.
        node_ids (list): List of nodes to which to distribute the intervention. [] or None indicates all nodes
            will get the intervention.
        repetitions (int): The number of times an intervention is given, used with **timesteps_between_repetitions**. -1 means
            the intervention repeats forever. Sets **Number_Repetitions**.
        target_age_min (float): The lower end of ages targeted for an intervention, in years. Sets **Target_Age_Min**.
        target_age_max (float): The upper end of ages targeted for an intervention, in years. Sets **Target_Age_Max**.
        timesteps_between_repetitions (int): The interval, in timesteps, between repetitions. Ignored if repetitions = 1.
            Sets **Timesteps_Between_Repetitions**.
        ind_property_restrictions (list): A list of dictionaries of IndividualProperties, which are needed for the individual
            to receive the intervention. Sets the **Property_Restrictions_Within_Node**.
        killing_initial_effect (float): Initial strength of the Killing effect. The effect may decay over time.
        killing_box_duration (float): Box duration of effect in days before the decay of **killing_initial_effect**.
        killing_decay_time_constant (float): The exponential decay length, in days of the **killing_initial_effect**.
        insecticide (str): 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 need to be specified or can be empty string. It cannot have a
            value if config.Insecticides does not define anything.
        cost (float): Unit cost per Ivermectin dosing (unamortized).
        intervention_name (str): The optional name used to refer to this intervention as a means to differentiate it from
            others that use the same class.
        broadcast_event (str): An event to be broadcast when a person receives Ivermectin intervention.
            Default: "Received_Ivermectin". You can turn this off by passing in an empty string or None.
    """

    intervention = _ivermectin(campaign=campaign,
                               killing_initial_effect=killing_initial_effect,
                               killing_box_duration=killing_box_duration,
                               killing_decay_time_constant=killing_decay_time_constant,
                               insecticide=insecticide,
                               cost=cost,
                               intervention_name=intervention_name)
    if broadcast_event:
        intervention = [intervention, BroadcastEvent(camp=campaign, Event_Trigger=broadcast_event)]

    add_campaign_event(campaign,
                       start_day=start_day,
                       demographic_coverage=demographic_coverage,
                       target_num_individuals=target_num_individuals,
                       node_ids=node_ids,
                       repetitions=repetitions,
                       target_age_min=target_age_min,
                       target_age_max=target_age_max,
                       timesteps_between_repetitions=timesteps_between_repetitions,
                       ind_property_restrictions=ind_property_restrictions,
                       individual_intervention=intervention)

add_triggered_ivermectin(campaign, start_day=1, trigger_condition_list=None, listening_duration=-1, delay_period_constant=0, demographic_coverage=1.0, target_age_min=0, target_age_max=MAX_AGE_YEARS, node_ids=None, ind_property_restrictions=None, killing_initial_effect=1, killing_box_duration=0, killing_decay_time_constant=90, insecticide='', cost=1, intervention_name='Ivermectin', broadcast_event='Received_Ivermectin')

Adds a triggered Ivermectin CampaignEvent to the campaign, that responds to a trigger after an optional delay. The intervention is distributed on start_day and responds to triggers for a listening_duration of days.

It is possible to have multiple Ivermectin interventions attached to a person if they have different Intervention_Name values.

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

Parameters:

Name	Type	Description	Default
campaign	EMODCampaign	campaign object to which the intervention will be added, and schema_path container.	required
start_day	int	The day on which the intervention is distributed.	1
trigger_condition_list	list	A list of the events that will trigger intervention distribution.	None
listening_duration	int	The number of time steps that the distributed event will monitor for triggers. Default is -1, which is indefinitely.	-1
delay_period_constant	float	Optional. Delay, in days, before the intervention is given out after a trigger is received.	0
demographic_coverage	float	This value is the probability that each individual in the target population will receive the intervention. It does not guarantee that the exact fraction of the target population set by Demographic_Coverage receives the intervention.	1.0
target_age_min	float	The lower end of ages targeted for an intervention, in years. Sets Target_Age_Min.	0
target_age_max	float	The upper end of ages targeted for an intervention, in years. Sets Target_Age_Max.	MAX_AGE_YEARS
node_ids	list	List of nodes to which to distribute the intervention. [] or None indicates all nodes will get the intervention.	None
ind_property_restrictions	list	A list of dictionaries of IndividualProperties, which are needed for the individual to receive the intervention. Sets the Property_Restrictions_Within_Node.	None
killing_initial_effect	float	Initial strength of the Killing effect. The effect may decay over time.	1
killing_box_duration	float	Box duration of effect in days before the decay of killing_initial_effect.	0
killing_decay_time_constant	float	The exponential decay length, in days of the killing_initial_effect.	90
insecticide	str	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 need to be specified or can be empty string. It cannot have a value if config.Insecticides does not define anything.	''
cost	float	Unit cost per Ivermectin dosing (unamortized).	1
intervention_name	str	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	'Ivermectin'
broadcast_event	str	An event to be broadcast when a person receives an Ivermectin intervention. Default: "Received_Ivermectin". You can turn this off by passing in an empty string or None.	'Received_Ivermectin'

Source code in emodpy_malaria/interventions/ivermectin.py

def add_triggered_ivermectin(campaign,
                             start_day: int = 1,
                             trigger_condition_list: list = None,
                             listening_duration: int = -1,
                             delay_period_constant: float = 0,
                             demographic_coverage: float = 1.0,
                             target_age_min: float = 0,
                             target_age_max: float = MAX_AGE_YEARS,
                             node_ids: list = None,
                             ind_property_restrictions: list = None,
                             killing_initial_effect: float = 1,
                             killing_box_duration: float = 0,
                             killing_decay_time_constant: float = 90,
                             insecticide: str = "",
                             cost: float = 1,
                             intervention_name: str = "Ivermectin",
                             broadcast_event: str = "Received_Ivermectin"
                             ):
    """
    Adds a triggered **Ivermectin** **CampaignEvent** to the campaign, that responds to a trigger after an optional
    delay. The intervention is distributed on **start_day** and responds to triggers for a **listening_duration** of days.

    It is possible to have multiple **Ivermectin** interventions attached to a person if they have
    different **Intervention_Name** values.

    For killing effects - depending on the parameters you set, different **WaningEffect** classes will be used:<br>
        • box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored<br>
        • box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential<br>
        • box_duration > 0 + decay_time_constant = 0 => WaningEffectBox<br>
        • box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential<br>

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): campaign object to which the intervention will be added, and schema_path container.
        start_day (int): The day on which the intervention is distributed.
        trigger_condition_list (list): A list of the events that will trigger intervention distribution.
        listening_duration (int): The number of time steps that the distributed event will monitor for triggers.
            Default is -1, which is indefinitely.
        delay_period_constant (float): Optional. Delay, in days, before the intervention is given out after a trigger
            is received.
        demographic_coverage (float): This value is the probability that each individual in the target population will
            receive the intervention. It does not guarantee that the exact fraction of the target population set by
            **Demographic_Coverage** receives the intervention.
        target_age_min (float): The lower end of ages targeted for an intervention, in years. Sets **Target_Age_Min**.
        target_age_max (float): The upper end of ages targeted for an intervention, in years. Sets **Target_Age_Max**.
        node_ids (list): List of nodes to which to distribute the intervention. [] or None indicates all nodes
            will get the intervention.
        ind_property_restrictions (list): A list of dictionaries of IndividualProperties, which are needed for the individual
            to receive the intervention. Sets the **Property_Restrictions_Within_Node**.
        killing_initial_effect (float): Initial strength of the Killing effect. The effect may decay over time.
        killing_box_duration (float): Box duration of effect in days before the decay of **killing_initial_effect**.
        killing_decay_time_constant (float): The exponential decay length, in days of the **killing_initial_effect**.
        insecticide (str): 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 need to be specified or can be empty string. It cannot have a
            value if config.Insecticides does not define anything.
        cost (float): Unit cost per **Ivermectin** dosing (unamortized).
        intervention_name (str): The optional name used to refer to this intervention as a means to differentiate it from
            others that use the same class.
        broadcast_event (str): An event to be broadcast when a person receives an **Ivermectin** intervention.
            Default: "Received_Ivermectin". You can turn this off by passing in an empty string or None.
    """

    intervention = _ivermectin(campaign=campaign,
                               killing_initial_effect=killing_initial_effect,
                               killing_box_duration=killing_box_duration,
                               killing_decay_time_constant=killing_decay_time_constant,
                               insecticide=insecticide,
                               cost=cost,
                               intervention_name=intervention_name)
    if broadcast_event:
        intervention = [intervention, BroadcastEvent(camp=campaign, Event_Trigger=broadcast_event)]

    add_triggered_campaign_delay_event(campaign=campaign,
                                       start_day=start_day,
                                       trigger_condition_list=trigger_condition_list,
                                       listening_duration=listening_duration,
                                       delay_period_constant=delay_period_constant,
                                       demographic_coverage=demographic_coverage,
                                       target_age_min=target_age_min,
                                       target_age_max=target_age_max,
                                       node_ids=node_ids,
                                       ind_property_restrictions=ind_property_restrictions,
                                       individual_intervention=intervention)