emodpy_tbhiv.interventions.hsb module

emodpy_tbhiv.interventions.hsb.HSB(camp, trigger_treatment_list, output_event, probability_per_step=1.0, start_day=1, duration=- 1, property_restrictions_list=[], nodeIDs=[], black_period=0, black_trigger='Blackout', event_name='HSB')

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

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.

  • output_event – Signal to broadcast when ‘health’ is ultimately sought (string).

  • probability_per_step – Probability of seeking per timestep, default to 1 which means near instantaneous.

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

  • black_period – Undocumented.

  • black_trigger – Undocumented.

  • event_name – Undocumented.

Returns

New campaign event that can be added to the campaign.

emodpy_tbhiv.interventions.hsb.new_intervention_as_file(camp, filename='hsb_diag.json')