emodpy_malaria.interventions.common module

This module contains functionality common to many interventions.

emodpy_malaria.interventions.common.MalariaDiagnostic(camp, Measurement_Sensitivity, Detection_Threshold, Diagnostic_Type)

Add a malaria diagnostic intervention to your campaign. This is equivalent to MalariaDiagnostic.

Parameters

  • camp – The emod_api.campaign object to which the intervention will be added.

  • Measurement_Sensitivity – The setting for Measurement_Sensitivity in MalariaDiagnostic.

  • Detection_Threshold – The setting for Detection_Threshold in MalariaDiagnostic.

  • Diagnostic_Type – The setting for Diagnostic_Type in MalariaDiagnostic. In addition to the accepted values listed there, you may also set TRUE_INFECTION_STATUS, which calls StandardDiagnostic instead.

Returns

The diagnostic intervention event.

emodpy_malaria.interventions.common.AntimalarialDrug(camp, Drug_Type, ctc=1.0)

Add an antimalarial drug intervention to your campaign. This is equivalent to AntimalarialDrug.

Parameters

  • camp – The emod_api.campaign object to which the intervention will be added.

  • Drug_Type – The name of the drug to distribute in a drugs intervention. Possible values are contained in Malaria_Drug_Params.

  • ctc – The cost to consumer.

Returns

The antimalarial drug intervention event.

emodpy_malaria.interventions.common.triggered_campaign_delay_event(camp, start_day, trigger, delay, intervention, ip_targeting=None, coverage=1.0, target_age_min=0, target_age_max=125.0)

Create and return a campaign event that responds to a trigger after a delay with an intervention.

Parameters

  • camp – emod_api.campaign object with schema_path set.

  • start_day – When to start.

  • trigger – E.g., “NewInfection”.

  • delay – Dictionary of 1 or 2 params that are the literal Delay_Distribution parameters, but without the distribution, which is inferred. E.g., { “Delay_Period_Exponential”: 5 }.

  • intervention – List of 1 or more valid intervention dictionaries to be distributed together.

  • ip_targeting – Optional Individual Properties required for someone to receive the intervntion(s).

  • coverage – Optional percentage coverage of target population. Defaults to all (100%).

  • target_age_min – Optional minimum age (in years). Defaults to 0.

  • target_age_max – Optional maximum age (in years). Defaults to 125.

Returns

Campaign event.