emodpy_tbhiv.interventions.triggered_pvc module#

emodpy_tbhiv.interventions.triggered_pvc.TPVC(camp, trigger_treatment_list, property_to_change, final_prop_value, revert=0, daily_prob=1, start_day=1, duration=-1, coverage=1.0, property_restrictions_list=[], nodeIDs=[], black_period=0, black_trigger='Blackout', event_name='PropertyValueChanger')[source]#

Create and return triggered campaign event that issues an PropertyValueChanger intervention. See PropertyValueChanger

Parameters:

  • camp – The emod_api.campaign module instance which serves as the campaign accumulator.

  • 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.

  • property_to_change – Individual Property key (string).

  • final_prop_value – New Individual Property value (string).

  • revert – … Defaults to 0.

  • daily_prob – Daily probabilty of changing. Defaults to 1.

  • 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.

  • coverage – Fraction of qualifiers who receive intervention. Defaults to 1.0 (100%).

  • property_restrictions_list – Optiional list of Individual Properties to limit the intervention to.

  • nodeIDs – Optiona list of node ids to target. Defaults to all.

  • black_period – Undocumented.

  • black_trigger – Undocumented.

  • event_name – Undocumented.

Returns:

New campaign event that can be added to the campaign.

emodpy_tbhiv.interventions.triggered_pvc.new_intervention_as_file(camp, filename='tpvc.json')[source]#