emodpy_tbhiv.interventions.hiv_seeding module

emodpy_tbhiv.interventions.hiv_seeding.seed(camp, disease='TB', coverage=0.01, reps=- 1, interval=1, start_day=1, nodeIDs=[], time_offset=1, event_name='HIV Incidence')

Create a scheduled campaign event that issues an OutbreakIndividualTBorHIV intervention. Useful for seeding interventions in TBHIV_SIM.

Parameters

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

  • time_offset – … Defaults to 0.

  • disease – “TB” or “HIV”. Default is “HIV”.

  • reps – Number of repetitions (integer). Defaults to no repetition.

  • interval – Timesteps between repetitions, if reps is set. Defaults to every day.

  • 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.hiv_seeding.new_intervention_as_file(camp, filename='hiv.json')