Source code for emodpy_hiv.interventions.outbreak

from typing import List

import emod_api.interventions.outbreak as ob
from emod_api import schema_to_class as s2c
import emod_api.campaign as campaign
import emod_api.interventions.common as common
from emodpy_hiv.interventions import utils as hiv_utils


def _outbreak(camp, cases=None):
    if cases is None:
        outbreak = s2c.get_class_with_defaults("OutbreakIndividual", camp.schema_path)
    else:
        outbreak = s2c.get_class_with_defaults("Outbreak", camp.schema_path)
        outbreak.Import_Cases = cases
    return outbreak


[docs]def new_intervention(timestep, camp, coverage=0.01):
    """
    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: event as dict
    """
    event = ob.seed_by_coverage(camp, timestep, coverage)
    # add h-o specific Target_Config
    from . import utils as hiv_utils
    hiv_utils.declutter(event)
    return event


[docs]def seed_infections(camp: campaign, start_day: int = 365, coverage: float = 0.075, target_properties: list = None,
                    target_min_age: float = 0, target_max_age: float = 125, target_gender: str = "All",
                    node_ids: List[int] = None, event_name=""):
    """
    Create outbreak event with more targeting than 'new_intervention'.
    """
    outbreak = _outbreak(camp)
    # outbreak['Intervention_Name'] = "Seeding"
    event = common.ScheduledCampaignEvent(camp, start_day, Demographic_Coverage=coverage, Intervention_List=[outbreak],
                                          Target_Age_Min=target_min_age, Target_Age_Max=target_max_age,
                                          Target_Gender=target_gender, Property_Restrictions=target_properties,
                                          Node_Ids=node_ids)
    hiv_utils.declutter(event)
    event['Event_Name'] = event_name
    return event