emodpy_tbhiv.interventions.art module¶
- emodpy_tbhiv.interventions.art.ART(camp, trigger_treatment_list, start_day=1, duration=-1, property_restrictions_list=[], nodeIDs=[], cost=0, black_period=0, black_trigger='Blackout', event_name='ART')[source]¶
Create and return triggered campaign event that issues an ART intervention.
- Parameters:
camp – Centralized campaign module instance.
trigger_treatment_list – List of 1 or more triggers (or events or signals) which are listened to and trigger the distribution of the intervention. There is no default.
start_day – The timestep when this campaign event takes effect. Defaults to 1.
duration – How long the campaign event remains in effect. Defaults to forever.
property_restrictions_list – Optiional list of Individual Properties to limit the intervention to.
nodeIDs – Optiona list of node ids to target. Defaults to all.
cost – Per unit ‘price’ of each intervention.
black_period – Undocumented.
black_trigger – Undocumented.
event_name – Undocumented.
- Returns:
New campaign event that can be added to the campaign.