emodpy_tbhiv.interventions.tb_treat_basic module

emodpy_tbhiv.interventions.tb_treat_basic.TBDrugTreatment(camp, trigger_treatment_list, drug_name='DOTS', inactivation_rate=0, mortality_rate=0, clearance_rate=0, resistance_rate=0, relapse_rate=0, reduced_transmit=1.0, start_day=1, treatment_duration=180, duration=- 1, property_restrictions_list=[], nodeIDs=[], black_period=0, black_trigger='Blackout', event_name='TBDrugTreatment')

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

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.

  • drug_name – … Defaults to ‘DOTS’,

  • inactivation_rate – … Defaults to 0,

  • mortality_rate – … Defaults to 0,

  • clearance_rate – … Defaults to 0,

  • resistance_rate – … Defaults to 0,

  • relapse_rate – … Defaults to 0,

  • reduced_transmit – … Defaults to 1.0,

  • 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.tb_treat_basic.new_intervention_as_file(camp, filename=None)