emodpy_malaria.interventions.drug module¶
This module contains functionality for defining antimalarial drug interventions.
-
emodpy_malaria.interventions.drug.
AntimalarialDrug
(campaign, start_day: int = 1, coverage: float = 1.0, drug_name: str = 'Chloroquine', node_ids: list = None)¶ Add an antimalarial drug intervention to your campaign. This is equivalent to AntimalarialDrug.
- Parameters
campaign – The
emod_api.campaign
object to which the intervention will be added.start_day – The day of the simulation on which the drug is distributed. We recommend aligning this with the start of the simulation.
coverage – The proportion of the population that will receive the drug.
drug_name – The name of the drug to distribute in a drug intervention. Possible values are contained in Malaria_Drug_Params in Drugs and treatments. Use
set_team_drug_params()
to set those values.node_ids – The IDs of the nodes in which to distribute the drug.
- Returns
The intervention event.
-
emodpy_malaria.interventions.drug.
new_intervention_as_file
(camp, start_day, filename=None)¶ Take an AntimalarialDrug intervention from a JSON file and add it to your campaign.
- Parameters
camp – The
emod_api.campaign
object to which the intervention will be added.start_day – The day of the simulation on which the drug is distributed. We recommend aligning this with the start of the simulation.
filename – The JSON file that contains the intervention.
- Returns
The filename.