emodpy_hiv.interventions.rapiddiag module#

emodpy_hiv.interventions.rapiddiag.new_diagnostic(camp, Positive_Event, Negative_Event, intervention_name: str | None = None, disqualifying_properties: List[str] | None = None, new_property_value: str | None = None)[source]#

Wrapper function to create and return a HIVRapidHIVDiagnostic intervention.

Parameters:

  • camp – emod_api.campaign object with schema_path set.

  • intervention_name (str) – The name of the intervention.

  • disqualifying_properties (list of str) – A list of IndividualProperty key:value pairs that cause an intervention to be aborted

  • new_property_value (str) – An optional IndividualProperty key:value pair that will be assigned when the intervention is distributed.

Returns:

Schema-based smart dictionary representing a new

Return type:

ReadOnlyDict

emodpy_hiv.interventions.rapiddiag.new_intervention_event(camp, pos_event, neg_event, start_day=1, coverage=1.0, node_ids=None, intervention_name: str | None = None, disqualifying_properties: List[str] | None = None, new_property_value: str | None = None)[source]#

Diagnostic as scheduled event.

emodpy_hiv.interventions.rapiddiag.new_intervention_as_file(camp, start_day, filename=None)[source]#