Source code for emodpy_hiv.interventions.malecirc

from emod_api import schema_to_class as s2c
from emod_api.interventions import utils
from emodpy_hiv.interventions.utils import set_intervention_properties

from typing import List


[docs]def new_intervention(camp, reduced_acquire=0.6, distributed_event='', intervention_name: str = None,
                     disqualifying_properties: List[str] = None, new_property_value: str = None):
    """
    MaleCircumcision intervention wrapper. Just the intervention. No configuration yet.
    """
    intervention = s2c.get_class_with_defaults("MaleCircumcision", camp.schema_path)
    intervention.Circumcision_Reduced_Acquire = reduced_acquire
    if distributed_event :
        intervention.Distributed_Event_Trigger = camp.get_send_trigger(distributed_event, True)
    set_intervention_properties(intervention,
                                intervention_name=intervention_name,
                                disqualifying_properties=disqualifying_properties,
                                new_property_value=new_property_value)
    return intervention


[docs]def new_intervention_event( 
        camp, 
        start_day=1, 
        coverage=1.0, 
        node_ids=None,
        intervention_name: str = None,
        disqualifying_properties: List[str] = None,
        new_property_value: str = None
    ):
    """
    VMMC intervention as complete (scheduled) event.
    """
    iv = new_intervention( camp,
                           intervention_name=intervention_name,
                           disqualifying_properties=disqualifying_properties,
                           new_property_value=new_property_value
                           )

    # Coordinator
    coordinator = s2c.get_class_with_defaults( "StandardEventCoordinator", camp.schema_path )
    coordinator.Intervention_Config = iv
    coordinator.Demographic_Coverage = coverage

    # Event
    event = s2c.get_class_with_defaults( "CampaignEvent", camp.schema_path ) 
    event.Event_Coordinator_Config = coordinator
    event.Start_Day = float(start_day)
    event.Nodeset_Config = utils.do_nodes( camp.schema_path, node_ids )
    from . import utils as hiv_utils
    hiv_utils.declutter( event )

    return event

[docs]def new_intervention_as_file( camp, start_day, filename=None ):
    import emod_api.campaign as camp
    camp.add( new_intervention_event( camp, start_day ), first=True )
    if filename is None:
        filename = "MaleCircumcision.json"
    camp.save( filename )
    return filename