emodpy_malaria.interventions.drug_campaign module

emodpy_malaria.interventions.drug_campaign.drug_configs_from_code(camp, drug_code: str = None)

Add a drug config to the simulation configuration based on its code and add the corresponding AntimalarialDrug intervention to the return dictionary. The drug_code needs to be one identified in the drug_cfg dictionary. For example passing the MDA_ALP drug code, will add the drugs config for Artemether, Lumefantrine, Primaquine to the configuration file and will return a dictionary containing a Full Treatment course for those 3 drugs. :param drug_code: Code of the drug to add :param drug_ineligibility_duration: used as a flag, if anything is present, we add [“DrugStatus:RecentDrug”] :param as Disqualifying_Properties:

Returns

A dictionary containing the parameters for an intervention using the given drug

emodpy_malaria.interventions.drug_campaign.add_drug_campaign(camp, campaign_type: str = 'MDA', drug_code: str = None, start_days: list = None, coverage: float = 1.0, repetitions: int = 1, tsteps_btwn_repetitions: int = 60, diagnostic_type: str = 'BLOOD_SMEAR_PARASITES', diagnostic_threshold: float = 40, diagnostic_sensitivity: float = 1, diagnostic_specificity: float = 1, measurement_sensitivity: float = 0.1, fmda_radius: int = 0, node_selection_type: str = 'DISTANCE_ONLY', trigger_coverage: float = 1.0, snowballs: int = 0, treatment_delay: int = 0, triggered_campaign_delay: int = 0, nodeIDs: list = None, target_group: any = 'Everyone', drug_ineligibility_duration: int = 0, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None, trigger_condition_list: list = None, listening_duration: int = - 1, adherent_drug_configs: list = None, target_residents_only: int = 1, check_eligibility_at_trigger: bool = False, receiving_drugs_event_name='Received_Campaign_Drugs')

Add a drug intervention, as specified in campaign_type, to the campaign. This intervention uses the MalariaDiagnostic class to create either a scheduled or a triggered event to the campaign and the AntimalarialDrug class to configure drug parameters. You can also specify a delay period for a triggered event that broadcasts afterwards.

Note

Dosing/Dosing_Type was removed, please use adeherent_drug_configs if you want something besides a full treatment. Also, drug_ineligibility_duration does not prevent diagnostics from being distributed, but it does prevent positively-tested patients from receiving the drugs.

Parameters

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

  • campaign_type – Type of drug campaign. Default is MDA. Available options are: * MDA * MSAT * SMC * fMDA * MTAT * rfMSAT * rfMDA

  • drug_code – The drug code of the drug regimen (AL, DP, etc; allowable types are defined in malaria_drugs.py).

  • start_days – List of start days (integers) when the drug regimen will be distributed. Due to diagnostic/treatment configuration, the earliest start day is 1. When trigger_condition_list is used then the first entry of start_days is the day to start listening for the trigger(s).

  • coverage – Demographic coverage of the distribution (fraction of people at home during campaign).

  • repetitions – Number of repetitions.

  • tsteps_btwn_repetitions – Timesteps between the repetitions.

  • diagnostic_type – Diagnostic config for diagnostic-dependent campaigns: * MSAT * fMDA * rfMSAT

  • diagnostic_threshold – Diagnostic config for diagnostic-dependent campaigns: * MSAT * fMDA * rfMSAT

  • diagnostic_sensitivity – Setting for Base_Sensitivity in the MalariaDiagnostic

  • diagnostic_specificity – Setting for Base_Specificity in the MalariaDiagnostic

  • measurement_sensitivity – setting for Measurement_Sensitivity in MalariaDiagnostic

  • fmda_radius – Radius (in km) of focal response upon finding infection. Default is 0. Used with household only.

  • node_selection_type – Node selection type for broadcasting focal response trigger. Available options are: * DISTANCE_ONLY: It will send the event to nodes that are within a given distance. * MIGRATION_NODES_ONLY: It will only send the event to nodes that the individual can migrate to. * DISTANCE_AND_MIGRATION: It will only send the even to migratable nodes that are within a given distance. Migrateable nodes are Local and Regional.

  • trigger_coverage – Used with RCD (Reactive Case Detection). Fraction of trigger events that will trigger an RCD. Coverage param sets the fraction of individuals reached during RCD response.

  • snowballs – Number of snowball levels in reactive response.

  • treatment_delay – For MSAT and fMDA, the length of time between administering diagnostic and giving drugs; for RCD, the length of time between treating index case and triggering RCD response.

  • triggered_campaign_delay – When using trigger_condition_list, this indicates the delay period between receiving the trigger event and running the triggered campaign intervention.

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • target_group – A dictionary of {'agemin': x, 'agemax': y} to target MDA, SMC, MSAT, fMDA to individuals between x and y years of age. Default is Everyone.

  • drug_ineligibility_duration – When set to > 0, use IndividualProperties to prevent people from receiving drugs too frequently. Demographics file will need to define the IP DrugStatus with possible values None and RecentDrug. Individuals with status RecentDrug will not receive drugs during drug campaigns, though they are still eligible for receiving diagnostics (in MSAT, etc). Individuals who receive drugs during campaigns will have their DrugStatus changed to RecentDrug for drug_ineligibility_duration days.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • ind_property_restrictions – List of IndividualProperty key:value pairs that individuals must have to receive the diagnostic intervention. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – List of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

  • trigger_condition_list – List of events that will begin a triggerable drug campaign, such as MDA, MSAT, SMC, fMDA, and MTAT.

  • listening_duration – Duration to listen for the trigger. Default is -1, which listens indefinitely.

  • adherent_drug_configs – List of adherent drug configurations, which are dictionaries from configure_adherent_drug.

  • target_residents_only – When set to true (1), the intervention is only distributed to individuals for whom the node is their home node. They are not visitors from another node.

  • check_eligibility_at_trigger – If triggered event is delayed, you have an option to check individual/node’s eligibility at the initial trigger or when the event is actually distributed after delay.

  • receiving_drugs_event_name – Event to send out when person received drugs. Default: ‘Received_Campaign_Drugs’

Returns

Dictionary with drug campaign parameters

emodpy_malaria.interventions.drug_campaign.add_MDA(camp, start_days: list = None, coverage: float = 1.0, drug_configs: list = None, receiving_drugs_event: emod_api.interventions.common.BroadcastEvent = None, repetitions: int = 1, tsteps_btwn_repetitions: int = 60, nodeIDs: list = None, expire_recent_drugs: emod_api.interventions.common.PropertyValueChanger = None, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None, target_group: any = 'Everyone', trigger_condition_list: list = None, listening_duration: int = - 1, triggered_campaign_delay: int = 0, target_residents_only: int = 1, check_eligibility_at_trigger: bool = False)

Add MDA (mass drug administration) drug intervention to campaign. If there are multiple start days in a list and trigger_condition_list is empty, then mda’s are created to run on the days in the start_days list. If the triggerer_condition_list is present, then a triggered mda is created and uses the first day of the start_days. If there are repetitions or a triggered_campaign_delay then separate nodeleveltriggered interventions are created with a delay that sends out an event that triggers the mda. Multiple start days are only valid for non-triggered mdas.

Parameters

  • camp – The DTKConfigBuilder

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

  • start_days – List of integers.

  • coverage – Demographic coverage of mda’s.

  • drug_configs – List of dictionaries of drug configurations to be given out, created in add_drug_campaign.

  • receiving_drugs_event – (Optional) Broadcast event container with event to be broadcast when drugs received.

  • repetitions – Number of repetitions for mda. For triggered mda, this is for a repeated mda after a trigger.

  • tsteps_btwn_repetitions – Timesteps between repeated scheduled mdas or between once-triggered repeated mdas.

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • expire_recent_drugs – PropertyValueChanger intervention that updates DrugStatus:Recent drug to individual properties.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – List of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

  • target_group – A dictionary targeting an age range and gender of individuals for treatment. In the format {"agemin": x, "agemax": y, "gender": z}. Default is Everyone.

  • trigger_condition_list – List of event triggers upon which mda(s) are distributed.

  • listening_duration – Duration to listen for the trigger. Default is -1, which listens indefinitely.

  • triggered_campaign_delay – Delay period between the trigger and the mda. Default is 0.

  • target_residents_only – When set to true (1), the intervention is only distributed to individuals for whom the node is their home node. They are not visitors from another node.

  • check_eligibility_at_trigger – If triggered event is delayed, you have an option to check individual/node’s eligibility at the initial trigger or when the event is actually distributed after delay.

Returns

None

emodpy_malaria.interventions.drug_campaign.add_MSAT(camp, start_days: list = None, coverage: float = 1.0, drug_configs: list = None, receiving_drugs_event: emod_api.interventions.common.BroadcastEvent = None, repetitions: int = 1, tsteps_btwn_repetitions: int = 60, treatment_delay: int = 0, diagnostic_type: str = 'BLOOD_SMEAR_PARASITES', diagnostic_threshold: float = 40, diagnostic_sensitivity: float = 1, diagnostic_specificity: float = 1, measurement_sensitivity: float = 0.1, nodeIDs: list = None, expire_recent_drugs: emod_api.interventions.common.PropertyValueChanger = None, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None, target_group: any = 'Everyone', trigger_condition_list: list = None, triggered_campaign_delay: int = 0, listening_duration: int = - 1, check_eligibility_at_trigger: bool = False)

Add a MSAT (mass screening and treatment) drug intervention to campaign. This is either scheduled (on days from start_days) or triggered (when trigger_condition_list is present).

Parameters

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

  • start_days – List of days on which to start the intervention.

  • coverage – Demographic coverage of the intervention.

  • drug_configs – List of dictionaries of drug configurations to be distributed, created in add_drug_campaign.

  • receiving_drugs_event – (Optional) Broadcast event container with event to be broadcast when drugs received.

  • repetitions – How many times the intervention will be repeated.

  • tsteps_btwn_repetitions – Time steps between repetitions.

  • treatment_delay – Delay before the triggered drug distribution is done.

  • diagnostic_type – Diagnostic type. Available options are: * TRUE_INFECTION_STATUS * BLOOD_SMEAR * PCR * PF_HRP2 * TRUE_PARASITE_DENSITY * HAS_FEVER

  • diagnostic_threshold – Diagnostic threshold values, which are based on the selected diagnostic type.

  • diagnostic_sensitivity – Setting for Base_Sensitivity in the MalariaDiagnostic

  • diagnostic_specificity – Setting for Base_Specificity in the MalariaDiagnostic

  • measurement_sensitivity – setting for Measurement_Sensitivity in MalariaDiagnostic

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • expire_recent_drugs – PropertyValueChanger intervention that updates DrugStatus to Recent drug in IndividualProperties.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • ind_property_restrictions – List of IndividualProperty key:value pairs that individuals must have to receive the diagnostic intervention. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – List of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

  • target_group – A dictionary of {'agemin': x, 'agemax': y} to target MDA, SMC, MSAT, fMDA to individuals between x and y years of age. Default is Everyone.

  • trigger_condition_list – List of events to trigger MSAT. When trigger_string is set, the first entry of start_days is the day that is used to start listening for the trigger(s), the campaign happens when the trigger(s) is received.

  • triggered_campaign_delay – How long to delay the actual intervention (drug giving) for after the trigger is received.

  • listening_duration – Duration to listen for the trigger. Default is -1, which listens indefinitely.

  • check_eligibility_at_trigger – If triggered event is delayed, you have an option to check individual/node’s eligibility at the initial trigger or when the event is actually distributed after delay. Default is false, checks at distribution.

Returns

None

emodpy_malaria.interventions.drug_campaign.add_fMDA(camp, start_days: list = None, trigger_coverage: float = 1, coverage: float = 1, drug_configs: list = None, receiving_drugs_event: emod_api.interventions.common.BroadcastEvent = None, repetitions: int = 1, tsteps_btwn_repetitions: int = 365, treatment_delay: int = 0, diagnostic_type: str = 'BLOOD_SMEAR_PARASITES', diagnostic_threshold: float = 40, diagnostic_sensitivity: float = 1, diagnostic_specificity: float = 1, measurement_sensitivity: float = 0.1, fmda_radius: int = 0, node_selection_type: str = 'DISTANCE_ONLY', nodeIDs: list = None, expire_recent_drugs: emod_api.interventions.common.PropertyValueChanger = None, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None, target_group: any = 'Everyone', trigger_condition_list: list = None, listening_duration: int = - 1, triggered_campaign_delay: int = 0, check_eligibility_at_trigger: bool = False)

Add a fMDA (focal mass drug administration) drug intervention to campaign. The fMDA is based on results from diagnostic survey, which is either scheduled (on days from start_days) or triggered (when trigger_condition_list is present).

Parameters

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

  • start_days – List of days on which to start the intervention.

  • trigger_coverage – Demographic coverage of the triggered intervention.

  • coverage – Demographic coverage of the intervention.

  • drug_configs – List of dictionaries of drug configurations to be distributed, created in add_drug_campaign.

  • receiving_drugs_event – (Optional) Broadcast event container with event to be broadcast when drugs received.

  • repetitions – How many times the intervention will be repeated.

  • tsteps_btwn_repetitions – Time steps between repetitions.

  • treatment_delay – Delay before the triggered drug distribution is done.

  • diagnostic_type – Diagnostic type. Available options are: * TRUE_INFECTION_STATUS * BLOOD_SMEAR * PCR * PF_HRP2 * TRUE_PARASITE_DENSITY * HAS_FEVER

  • diagnostic_threshold – Diagnostic threshold values, which are based on the selected diagnostic type.

  • diagnostic_sensitivity – Setting for Base_Sensitivity in the MalariaDiagnostic

  • diagnostic_specificity – Setting for Base_Specificity in the MalariaDiagnostic

  • measurement_sensitivity – setting for Measurement_Sensitivity in MalariaDiagnostic

  • fmda_radius – Radius of the follow up BroadcastToOtherNodes interventions, uses node_selection_type.

  • node_selection_type – Node selection type for broadcasting fMDA trigger. Available options are: * DISTANCE_ONLY: Nodes located within the distance specified by fmda_type are selected. * MIGRATION_NODES_ONLY: Nodes that are local or regional are selected. * DISTANCE_AND_MIGRATION: Nodes are selected using DISTANCE_ONLY and MIGRATION_NODES_ONLY criteria.

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • expire_recent_drugs – PropertyValueChanger intervention that updates DrugStatus to Recent drug in IndividualProperties.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • ind_property_restrictions – List of IndividualProperty key:value pairs that individuals must have to receive the diagnostic intervention. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – List of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

  • target_group – A dictionary of {'agemin': x, 'agemax': y} to target MDA, SMC, MSAT, fMDA to individuals between x and y years of age. Default is Everyone.

  • trigger_condition_list – List of events to trigger fMDA. When trigger_string is set, the first entry of start_days is the day that is used to start listening for the trigger(s), the campaign happens when the trigger(s) is received.

  • listening_duration – Duration to listen for the trigger. Default is -1, which listens indefinitely.

  • triggered_campaign_delay – How long to delay the actual intervention (drug giving) after the trigger is received.

  • check_eligibility_at_trigger – If triggered event is delayed, you have an option to check individual/node’s eligibility at the initial trigger or when the event is actually distributed after delay. Default is false, checks at distribution.

Returns

None

emodpy_malaria.interventions.drug_campaign.add_rfMSAT(camp, start_day: int = 0, coverage: float = 1, drug_configs: list = None, receiving_drugs_event: emod_api.interventions.common.BroadcastEvent = None, listening_duration: int = - 1, treatment_delay: int = 0, trigger_coverage: float = 1, diagnostic_type: str = 'BLOOD_SMEAR_PARASITES', diagnostic_threshold: float = 40, diagnostic_sensitivity: float = 1, diagnostic_specificity: float = 1, measurement_sensitivity: float = 0.1, fmda_radius: int = 0, node_selection_type: str = 'DISTANCE_ONLY', snowballs: int = 0, nodeIDs: list = None, expire_recent_drugs: emod_api.interventions.common.PropertyValueChanger = None, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None)

Add a rfMDA (reactive focal mass drug administration) drug intervention to campaign. Detecting malaria triggers diagnostic surveys to run on neighboring nodes and so on, up to the number of trigggered interventions defined in snowballs parameter.

Parameters

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

  • start_day – List of days on which to start the intervention.

  • coverage – Demographic coverage of the intervention.

  • drug_configs – List of dictionaries of drug configurations to be distributed, created in add_drug_campaign.

  • receiving_drugs_event – (Optional) Broadcast event container with event to be broadcast when drugs received.

  • listening_duration – Duration of the existence of the intervention.

  • treatment_delay – delay before the triggered drug distribution is done

  • trigger_coverage – Demographic coverage for the triggered intervention

  • diagnostic_type – Diagnostic type. Available options are: * TRUE_INFECTION_STATUS * BLOOD_SMEAR * PCR * PF_HRP2 * TRUE_PARASITE_DENSITY * HAS_FEVER

  • diagnostic_threshold – Diagnostic threshold values, which are based on the selected diagnostic type.

  • diagnostic_sensitivity – Setting for Base_Sensitivity in the MalariaDiagnostic

  • diagnostic_specificity – Setting for Base_Specificity in the MalariaDiagnostic

  • measurement_sensitivity – setting for Measurement_Sensitivity in MalariaDiagnostic

  • fmda_radius – Radius of the follow up BroadcastToOtherNodes interventions, uses node_selection_type.

  • node_selection_type – Node selection type for broadcasting fMDA trigger. Available options are: * DISTANCE_ONLY: Nodes located within the distance specified by fmda_type are selected. * MIGRATION_NODES_ONLY: Nodes that are local or regional are selected. * DISTANCE_AND_MIGRATION: Nodes are selected using DISTANCE_ONLY and MIGRATION_NODES_ONLY criteria.

  • snowballs – Number of triggered interventions after the first.

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • expire_recent_drugs – PropertyValueChanger intervention that updates DrugStatus to Recent drug in IndividualProperties.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • ind_property_restrictions – List of IndividualProperty key:value pairs that individuals must have to receive the diagnostic intervention. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – List of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

Returns

None

emodpy_malaria.interventions.drug_campaign.add_rfMDA(camp, start_day: int = 0, coverage: float = 1, drug_configs: list = None, receiving_drugs_event: emod_api.interventions.common.BroadcastEvent = None, listening_duration: int = - 1, treatment_delay: int = 0, trigger_coverage: float = 1, fmda_radius: int = 0, node_selection_type: str = 'DISTANCE_ONLY', nodeIDs: list = None, expire_recent_drugs: emod_api.interventions.common.PropertyValueChanger = None, node_property_restrictions: list = None, ind_property_restrictions: list = None, disqualifying_properties: list = None)

This function adds two interventions to your campaign file: 1) “Received_Treatment”- triggered BroadcastEventToOtherNodes of “Give_Drugs_rfMDA” event to fmda_radius, with a “treatment_delay” option, and “coverage” coverage. 2) “Give_Drugs_rfMDA” event-triggered MultiIntervention event distributing “drug_configs” drugs, with “trigger_coverage” demographic coverage, with an option to restrict to {“DrugStatus”: “None”} IndividualProperty and optional receiving_drugs_event.

Upon “Received_Treatment” event a delayed “Give_Drugs_rfMDA” is sent out to (optionally) neighboring nodes, which triggers giving of drugs, and (optionally) an individualproperty change and another event being sent.

Parameters

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

  • start_day – The day the intervention is distributed. Default is 0.

  • coverage – Demographic coverage of the intervention.

  • drug_configs – List of dictionaries of drug configurations to be distributed, created in add_drug_campaign.

  • receiving_drugs_event – Event to be sent out upon receiving drugs. Default is 1, everyone.

  • listening_duration – Duration of the existence of the intervention. Default is ongoing.

  • treatment_delay – Delay of treatment (in days) after intervention is triggered.

  • trigger_coverage – Demographic coverage for intervention triggered by successful treatment.

  • fmda_radius – Radius (km) of sending event to other nodes.

  • node_selection_type – Node selection type. Available options are: * DISTANCE_ONLY: Nodes located within the distance specified by fmda_type are selected. * MIGRATION_NODES_ONLY: Nodes that are local or regional are selected. * DISTANCE_AND_MIGRATION: Nodes are selected using DISTANCE_ONLY and MIGRATION_NODES_ONLY criteria.

  • nodeIDs – The list of nodes to apply this intervention to (Node_List parameter). If not provided, set value of NodeSetAll.

  • expire_recent_drugs – PropertyValueChanger intervention that updates DrugStatus to Recent drug in IndividualProperties.

  • node_property_restrictions – List of NodeProperty key:value pairs that nodes must have to receive the diagnostic intervention. For example, [{"NodeProperty1":"PropertyValue1"}, {"NodeProperty2":"PropertyValue2"}]. Default is no restrictions.

  • ind_property_restrictions – List of IndividualProperty key:value pairs that individuals must have to receive the diagnostic intervention. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}]. Default is no restrictions.

  • disqualifying_properties – ist of IndividualProperty key:value pairs that cause an intervention to be aborted. For example, [{"IndividualProperty1":"PropertyValue1"}, {"IndividualProperty2":"PropertyValue2"}].

Returns

None

emodpy_malaria.interventions.drug_campaign.fmda_cfg(camp, fmda_type: any = 0, node_selection_type: str = 'DISTANCE_ONLY', event_trigger: str = 'Give_Drugs')

By Default, this is within the node-only (Distance_Only with distance=0).

Parameters

  • fmda_type – Radius in km of the follow up BroadcastToOtherNodes interventions, uses node_selection_type.

  • node_selection_type – Node selection type for broadcasting to other nodes. Available options are: * DISTANCE_ONLY: Nodes located within the distance specified by fmda_type are selected. * MIGRATION_NODES_ONLY: Nodes that are local or regional are selected. * DISTANCE_AND_MIGRATION: Nodes are selected using DISTANCE_ONLY and MIGRATION_NODES_ONLY criteria.

  • event_trigger – String that triggers the broadcast.

Returns

Configured BroadcastEventToOtherNodes