emodpy_hiv.interventions.outbreak module#

emodpy_hiv.interventions.outbreak.new_intervention(timestep, camp, coverage=0.01)[source]#

Seed HIV infection at a certain timestep, with a certain prevalence.

Parameters:

  • timestep (float) – When? Timestep at which outbreak should occur.

  • camp – emod_api.campaign object that has schema_path.

  • coverage – How Much? The intended level of initial prevalance.

Returns:

event as dict

Return type:

event

emodpy_hiv.interventions.outbreak.seed_infections(camp: <module 'emod_api.campaign' from '/home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-emodpy-hiv/envs/latest/lib/python3.9/site-packages/emod_api/campaign.py'>, start_day: int = 365, coverage: float = 0.075, target_properties: list | None = None, target_min_age: float = 0, target_max_age: float = 125, target_gender: str = 'All', node_ids: ~typing.List[int] | None = None, event_name='')[source]#

Create outbreak event with more targeting than ‘new_intervention’.