emodpy_malaria.interventions.inputeir module

emodpy_malaria.interventions.inputeir.new_intervention(campaign, monthly_eir: list = None, daily_eir: list = None, age_dependence: str = 'OFF', scaling_factor: float = 1.0)

Create the InputEIR intervention itself that will be nestled inside an event coordinator.

Parameters

  • campaign – Passed in campaign (from emod_api.campaign)

  • monthly_eir – An array of 12 elements that contain an entomological inoculation rate (EIR) for each month; Each value should be between 0 and 1000

  • daily_eir – An array of 365 values where each value is the mean number of infectious bites experienced by an individual for that day of the year

  • age_dependence – Determines how InputEIR depends on the age of the target. Options are “OFF”, “LINEAR”, “SURFACE_AREA_DEPENDENT”

  • scaling_factor – A modifier that is multiplied by the EIR determined for the current day

Returns

InputEIR intervention

emodpy_malaria.interventions.inputeir.InputEIR(campaign, monthly_eir: list = None, daily_eir: list = None, start_day: int = 1, node_ids: list = None, age_dependence: str = 'OFF', scaling_factor: float = 1.0)

Create a full CampaignEvent that distributes InputEIR to a population.

Parameters

  • campaign – Passed in campaign (from emod_api.campaign)

  • monthly_eir – An array of 12 elements that contain an entomological inoculation rate (EIR) for each month; Each value should be between 0 and 1000

  • daily_eir – An array of 365 values where each value is the mean number of infectious bites experienced by an individual for that day of the year

  • start_day – The day on which the monthly_eir cycle starts

  • node_ids – Nodes to which this intervention is applied

  • age_dependence – Determines how InputEIR depends on the age of the target. Options are “OFF”, “LINEAR”, “SURFACE_AREA_DEPENDENT”

  • scaling_factor – A modifier that is multiplied by the EIR determined for the current day

Returns

Campaign event to be added to campaign (from emod_api.camapign)

emodpy_malaria.interventions.inputeir.new_intervention_as_file(campaign, start_day: int = 0, monthly_eir: list = None, daily_eir: list = None, filename: str = None)

Create an InputEIR intervention as its own file.

Parameters

  • campaign – Passed in campaign (from emod_api.campaign)

  • start_day – The day on which the monthly_eir cycle starts

  • monthly_eir – An array of 12 elements that contain an entomological inoculation rate (EIR) for each month; Each value should be between 0 and 1000

  • daily_eir – An array of 365 values where each value is the mean number of infectious bites experienced by an individual for that day of the year

  • filename – filename used for the file created

Returns

The filename of the file created

emodpy_malaria.interventions.inputeir.add_InputEIR(campaign, monthly_eir: list = None, daily_eir: list = None, start_day: int = 1, node_ids: list = None, age_dependence: str = 'OFF', scaling_factor: float = 1.0)

Wrapper that creates a full CampaignEvent that distributes InputEIR to a population AND adds it to the campaign.

Parameters

  • campaign – Passed in campaign (from emod_api.campaign)

  • monthly_eir – An array of 12 elements that contain an entomological inoculation rate (EIR) for each month; Each value should be between 0 and 1000

  • daily_eir – An array of 365 values where each value is the mean number of infectious bites experienced by an individual for that day of the year

  • start_day – The day on which the monthly_eir cycle starts

  • node_ids – Nodes to which this intervention is applied

  • age_dependence – Determines how InputEIR depends on the age of the target. Options are “OFF”, “LINEAR”, “SURFACE_AREA_DEPENDENT”

  • scaling_factor – A modifier that is multiplied by the EIR determined for the current day