emodpy_hiv.demographics.society module#

class emodpy_hiv.demographics.society.Society(concurrency_configuration: Dict | None = None, relationship_parameters: Dict[str, RelationshipParameters] | None = None, pair_formation_parameters: Dict[str, PairFormationParameters] | None = None, concurrency_parameters: Dict[str, Dict[str, ConcurrencyParameters]] | None = None)[source]#

Bases: object

property relationship_types: Set[str]#

get_pair_formation_parameters_by_relationship_type(relationship_type: str) → PairFormationParameters[source]#

get_concurrency_parameters_by_relationship_type_and_risk(relationship_type: str, risk: str) → ConcurrencyParameters[source]#

get_relationship_parameters_by_relationship_type(relationship_type: str) → RelationshipParameters[source]#

set_pair_formation_parameters(relationship_type: str, formation_rate: float | None = None, assortivity: Assortivity | None = None) → None[source]#

set_concurrency_parameters(relationship_type: str, risk: str, max_simul_rels_male: float | None = None, max_simul_rels_female: float | None = None, prob_xtra_rel_male: float | None = None, prob_xtra_rel_female: float | None = None) → None[source]#

set_relationship_parameters(relationship_type: str, coital_act_rate: float | None = None, condom_usage_min: float | None = None, condom_usage_mid: float | None = None, condom_usage_max: float | None = None, condom_usage_rate: float | None = None, duration_scale: float | None = None, duration_heterogeneity: float | None = None) → None[source]#

to_dict() → Dict[source]#

classmethod from_dict(d: Dict) → __class__[source]#