Source code for emodpy_hiv.demographics.DemographicsTemplates

from copy import deepcopy
from typing import Dict

# TODO: consider removing the current 'default' entry and using PFA-Southern-Africa as the actual default, as
#  the current 'default' is not properly functional (in a full sense) anyway. (e.g. missing risk based assortivity)
#  https://github.com/InstituteforDiseaseModeling/emodpy-hiv/issues/214

societies = dict()


societies["PFA-Southern-Africa"] = {
    "Society": {
        "Concurrency_Configuration": {
            "Probability_Person_Is_Behavioral_Super_Spreader": 0,
            "Individual_Property_Name": "Risk",
            "HIGH": {
                "Extra_Relational_Flag_Type": "Correlated",
                "Correlated_Relationship_Type_Order": [
                    "COMMERCIAL",
                    "TRANSITORY",
                    "INFORMAL",
                    "MARITAL"
                ]
            },
            "LOW": {
                "Extra_Relational_Flag_Type": "Correlated",
                "Correlated_Relationship_Type_Order": [
                    "COMMERCIAL",
                    "TRANSITORY",
                    "INFORMAL",
                    "MARITAL"
                ]
            },
            "MEDIUM": {
                "Extra_Relational_Flag_Type": "Correlated",
                "Correlated_Relationship_Type_Order": [
                    "COMMERCIAL",
                    "TRANSITORY",
                    "INFORMAL",
                    "MARITAL"
                ]
            }
        },
        "COMMERCIAL": {
            "Relationship_Parameters": {
                "Coital_Act_Rate": 0.0027397260273972603,
                "Condom_Usage_Probability": {
                    "Max": 0.85,
                    "Mid": 1999.5,
                    "Min": 0.5,
                    "Rate": 1
                },
                "Duration_Weibull_Heterogeneity": 1,
                "Duration_Weibull_Scale": 0.01917808219,
                "Migration_Actions": [
                    "TERMINATE"
                ],
                "Migration_Actions_Distribution": [
                    1.0
                ]
            },
            "Concurrency_Parameters": {
                "HIGH": {
                    "Max_Simultaneous_Relationships_Female": 59,
                    "Max_Simultaneous_Relationships_Male": 59,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                },
                "LOW": {
                    "Max_Simultaneous_Relationships_Female": 0,
                    "Max_Simultaneous_Relationships_Male": 0,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                },
                "MEDIUM": {
                    "Max_Simultaneous_Relationships_Female": 0,
                    "Max_Simultaneous_Relationships_Male": 0,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                }
            },
            "Pair_Formation_Parameters": {
                "Age_of_First_Bin_Edge_Female": 15,
                "Age_of_First_Bin_Edge_Male": 15,
                "Extra_Relational_Rate_Ratio_Female": 10,
                "Extra_Relational_Rate_Ratio_Male": 10,
                "Formation_Rate_Constant": 0.15,
                "Formation_Rate_Type": "CONSTANT",
                "Number_Age_Bins_Female": 1,
                "Number_Age_Bins_Male": 1,
                "Update_Period": 7,
                "Years_Between_Bin_Edges_Female": 35,
                "Years_Between_Bin_Edges_Male": 35,
                "Joint_Probabilities": [
                    [
                        1
                    ]
                ],
                "Assortivity": {
                    "Axes": [
                        "LOW", 
                        "MEDIUM", 
                        "HIGH"
                    ], 
                    "Group": "INDIVIDUAL_PROPERTY", 
                    "Property_Name": "Risk", 
                    "Weighting_Matrix_RowMale_ColumnFemale": [
                        [1, 1, 1], 
                        [1, 1, 1], 
                        [1, 1, 1]
                    ]
                }
            }
        },
        "INFORMAL": {
            "Relationship_Parameters": {
                "Coital_Act_Rate": 0.33,
                "Condom_Usage_Probability": {
                    "Max": 0.3276293852,
                    "Mid": 1998.5140953411,
                    "Min": 0.0,
                    "Rate": 1.4303827593
                },
                "Duration_Weibull_Heterogeneity": 0.75,
                "Duration_Weibull_Scale": 2.03104913138,
                "Migration_Actions": [
                    "TERMINATE"
                ],
                "Migration_Actions_Distribution": [
                    1.0
                ]
            },
            "Concurrency_Parameters": {
                "HIGH": {
                    "Max_Simultaneous_Relationships_Female": 1,
                    "Max_Simultaneous_Relationships_Male": 1,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                },
                "LOW": {
                    "Max_Simultaneous_Relationships_Female": 1.6052079364461302,
                    "Max_Simultaneous_Relationships_Male": 1.6052079364461302,
                    "Prob_Extra_Relationship_Female": 0,
                    "Prob_Extra_Relationship_Male": 0.5327652181646236
                },
                "MEDIUM": {
                    "Max_Simultaneous_Relationships_Female": 0.9156884274249174,
                    "Max_Simultaneous_Relationships_Male": 0.9156884274249174,
                    "Prob_Extra_Relationship_Female": 0.39942859326457386,
                    "Prob_Extra_Relationship_Male": 0.37086485516189854
                }
            },
            "Pair_Formation_Parameters": {
                "Age_of_First_Bin_Edge_Female": 17.5,
                "Age_of_First_Bin_Edge_Male": 17.5,
                "Extra_Relational_Rate_Ratio_Female": 10,
                "Extra_Relational_Rate_Ratio_Male": 10,
                "Formation_Rate_Constant": 0.0010841069,
                "Formation_Rate_Type": "CONSTANT",
                "Number_Age_Bins_Female": 20,
                "Number_Age_Bins_Male": 20,
                "Update_Period": 7,
                "Years_Between_Bin_Edges_Female": 2.5,
                "Years_Between_Bin_Edges_Male": 2.5,
                "Joint_Probabilities": [
                    [
                        0.02182,
                        0.016798,
                        0.008474,
                        0.002572,
                        0.000566,
                        0.000133,
                        1.2e-05,
                        2e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.022878,
                        0.018808,
                        0.011747,
                        0.005706,
                        0.002183,
                        0.000534,
                        6.1e-05,
                        1.2e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.025094,
                        0.02359,
                        0.019998,
                        0.013835,
                        0.006582,
                        0.001817,
                        0.000321,
                        7.5e-05,
                        8e-06,
                        3e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.024383,
                        0.026075,
                        0.027147,
                        0.02221,
                        0.012255,
                        0.004504,
                        0.001348,
                        0.000349,
                        6.1e-05,
                        2.5e-05,
                        8e-06,
                        2e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.017162,
                        0.021429,
                        0.026924,
                        0.025626,
                        0.01725,
                        0.008852,
                        0.003661,
                        0.001076,
                        0.000252,
                        9.2e-05,
                        2.7e-05,
                        6e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.008432,
                        0.013738,
                        0.021613,
                        0.02418,
                        0.019887,
                        0.013033,
                        0.006651,
                        0.002503,
                        0.000812,
                        0.000255,
                        6.3e-05,
                        1.9e-05,
                        4e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.003736,
                        0.007791,
                        0.01437,
                        0.018571,
                        0.018491,
                        0.014865,
                        0.009391,
                        0.004734,
                        0.001979,
                        0.000629,
                        0.00017,
                        6.2e-05,
                        1.9e-05,
                        6e-06,
                        2e-06,
                        1e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.001699,
                        0.003707,
                        0.007467,
                        0.011553,
                        0.014397,
                        0.014112,
                        0.010869,
                        0.006905,
                        0.003605,
                        0.001505,
                        0.000575,
                        0.000218,
                        7.9e-05,
                        3.4e-05,
                        1.7e-05,
                        1e-05,
                        4e-06,
                        1e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000649,
                        0.001503,
                        0.003405,
                        0.006352,
                        0.009457,
                        0.010871,
                        0.010096,
                        0.007985,
                        0.005372,
                        0.00307,
                        0.001478,
                        0.000581,
                        0.000222,
                        0.000103,
                        5.3e-05,
                        3e-05,
                        1.2e-05,
                        2e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000253,
                        0.000604,
                        0.001471,
                        0.003029,
                        0.005049,
                        0.006871,
                        0.007949,
                        0.007848,
                        0.006588,
                        0.004633,
                        0.002576,
                        0.00113,
                        0.000463,
                        0.000197,
                        9.3e-05,
                        5e-05,
                        2e-05,
                        4e-06,
                        0.0,
                        0.0
                    ],
                    [
                        9.6e-05,
                        0.000274,
                        0.000712,
                        0.001492,
                        0.002634,
                        0.004087,
                        0.005552,
                        0.006489,
                        0.006506,
                        0.005362,
                        0.00345,
                        0.001796,
                        0.000819,
                        0.000328,
                        0.000137,
                        6.7e-05,
                        2.5e-05,
                        6e-06,
                        1e-06,
                        0.0
                    ],
                    [
                        6.6e-05,
                        0.000224,
                        0.000546,
                        0.000969,
                        0.001526,
                        0.002331,
                        0.003383,
                        0.004556,
                        0.005399,
                        0.005125,
                        0.003806,
                        0.00237,
                        0.001298,
                        0.000621,
                        0.000278,
                        0.000118,
                        4.5e-05,
                        1.5e-05,
                        4e-06,
                        1e-06
                    ],
                    [
                        3.4e-05,
                        0.000126,
                        0.000314,
                        0.000562,
                        0.000882,
                        0.001325,
                        0.001955,
                        0.002844,
                        0.003711,
                        0.003916,
                        0.003386,
                        0.002613,
                        0.001862,
                        0.001172,
                        0.000606,
                        0.000252,
                        9.8e-05,
                        3.9e-05,
                        1.2e-05,
                        3e-06
                    ],
                    [
                        9e-06,
                        3.3e-05,
                        0.000107,
                        0.000275,
                        0.000523,
                        0.000781,
                        0.001072,
                        0.001508,
                        0.002033,
                        0.002423,
                        0.002583,
                        0.002548,
                        0.002296,
                        0.001748,
                        0.00103,
                        0.000478,
                        0.000199,
                        7.3e-05,
                        2.1e-05,
                        6e-06
                    ],
                    [
                        0.0,
                        0.0,
                        2.1e-05,
                        0.000106,
                        0.000244,
                        0.00037,
                        0.000495,
                        0.000703,
                        0.001023,
                        0.001429,
                        0.00186,
                        0.002219,
                        0.002354,
                        0.002059,
                        0.001414,
                        0.000786,
                        0.000357,
                        0.00012,
                        3e-05,
                        8e-06
                    ],
                    [
                        0.0,
                        0.0,
                        6e-06,
                        2.8e-05,
                        6.6e-05,
                        0.000112,
                        0.000179,
                        0.000309,
                        0.000527,
                        0.000843,
                        0.001243,
                        0.001692,
                        0.00204,
                        0.002018,
                        0.001612,
                        0.001064,
                        0.000557,
                        0.000218,
                        6.7e-05,
                        1.8e-05
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        3e-06,
                        1.3e-05,
                        5.3e-05,
                        0.000161,
                        0.000337,
                        0.000537,
                        0.000769,
                        0.001088,
                        0.001424,
                        0.001582,
                        0.001485,
                        0.001178,
                        0.000762,
                        0.000404,
                        0.000178,
                        7.8e-05
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        1e-06,
                        3e-06,
                        3.4e-05,
                        0.000143,
                        0.000303,
                        0.00041,
                        0.000468,
                        0.000594,
                        0.000806,
                        0.001025,
                        0.00116,
                        0.001107,
                        0.000884,
                        0.000635,
                        0.000444,
                        0.00035
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        2.4e-05,
                        0.000119,
                        0.000259,
                        0.000338,
                        0.000354,
                        0.0004,
                        0.000512,
                        0.000665,
                        0.000808,
                        0.000863,
                        0.000843,
                        0.000852,
                        0.00091,
                        0.000951
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        2e-05,
                        0.000101,
                        0.000223,
                        0.000309,
                        0.000345,
                        0.000378,
                        0.000427,
                        0.000485,
                        0.000549,
                        0.000625,
                        0.000753,
                        0.001001,
                        0.001315,
                        0.001501
                    ]
                ],
                "Assortivity": {
                    "Axes": [
                        "LOW", 
                        "MEDIUM", 
                        "HIGH"
                    ],
                    "Group": "INDIVIDUAL_PROPERTY", 
                    "Property_Name": "Risk", 
                    "Weighting_Matrix_RowMale_ColumnFemale": [
                        [0.6097767084, 0.3902232916, 0], 
                        [0.3902232916, 0.6097767084, 0.6097767084], 
                        [0, 0.6097767084, 0.3902232916]
                    ]
                }
            }
        },
        "MARITAL": {
            "Relationship_Parameters": {
                "Coital_Act_Rate": 0.33,
                "Condom_Usage_Probability": {
                    "Max": 0.223467644,
                    "Mid": 1997.7147536264,
                    "Min": 0.0,
                    "Rate": 2.8631895001
                },
                "Duration_Weibull_Heterogeneity": 0.666666667,
                "Duration_Weibull_Scale": 22.154455184937,
                "Migration_Actions": [
                    "TERMINATE"
                ],
                "Migration_Actions_Distribution": [
                    1.0
                ]
            },
            "Concurrency_Parameters": {
                "HIGH": {
                    "Max_Simultaneous_Relationships_Female": 1,
                    "Max_Simultaneous_Relationships_Male": 1,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                },
                "LOW": {
                    "Max_Simultaneous_Relationships_Female": 1,
                    "Max_Simultaneous_Relationships_Male": 1,
                    "Prob_Extra_Relationship_Female": 0,
                    "Prob_Extra_Relationship_Male": 0
                },
                "MEDIUM": {
                    "Max_Simultaneous_Relationships_Female": 0.9,
                    "Max_Simultaneous_Relationships_Male": 0.9,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                }
            },
            "Pair_Formation_Parameters": {
                "Age_of_First_Bin_Edge_Female": 17.5,
                "Age_of_First_Bin_Edge_Male": 17.5,
                "Extra_Relational_Rate_Ratio_Female": 10,
                "Extra_Relational_Rate_Ratio_Male": 10,
                "Formation_Rate_Constant": 5.47945e-05,
                "Formation_Rate_Type": "CONSTANT",
                "Number_Age_Bins_Female": 20,
                "Number_Age_Bins_Male": 20,
                "Update_Period": 30,
                "Years_Between_Bin_Edges_Female": 2.5,
                "Years_Between_Bin_Edges_Male": 2.5,
                "Joint_Probabilities": [
                    [
                        0.001014,
                        0.000773,
                        0.000377,
                        0.000102,
                        1.6e-05,
                        3e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.001467,
                        0.001149,
                        0.000618,
                        0.000222,
                        6.2e-05,
                        1.2e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.00211,
                        0.00174,
                        0.001116,
                        0.000633,
                        0.000393,
                        0.000235,
                        9.8e-05,
                        2e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.002212,
                        0.002054,
                        0.001796,
                        0.00162,
                        0.001472,
                        0.001076,
                        0.000489,
                        9.8e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.001684,
                        0.001953,
                        0.002461,
                        0.003028,
                        0.003301,
                        0.002735,
                        0.001514,
                        0.000551,
                        0.000155,
                        3.1e-05,
                        1e-06,
                        5e-06,
                        9e-06,
                        9e-06,
                        5e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.00104,
                        0.001617,
                        0.002774,
                        0.004255,
                        0.005423,
                        0.005206,
                        0.003661,
                        0.001972,
                        0.000775,
                        0.000155,
                        5e-06,
                        2.4e-05,
                        4.7e-05,
                        4.7e-05,
                        2.4e-05,
                        5e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.000569,
                        0.0012,
                        0.002613,
                        0.004826,
                        0.007094,
                        0.007849,
                        0.006726,
                        0.004557,
                        0.002234,
                        0.000711,
                        0.000183,
                        9.2e-05,
                        0.000101,
                        9.7e-05,
                        5e-05,
                        1.3e-05,
                        2e-06,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.000339,
                        0.00083,
                        0.002079,
                        0.004396,
                        0.007285,
                        0.009393,
                        0.009818,
                        0.008106,
                        0.004974,
                        0.002315,
                        0.000877,
                        0.000269,
                        0.000126,
                        0.000108,
                        6.3e-05,
                        2.5e-05,
                        8e-06,
                        2e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000293,
                        0.00057,
                        0.001407,
                        0.003244,
                        0.006069,
                        0.009393,
                        0.011954,
                        0.011712,
                        0.008762,
                        0.005333,
                        0.002674,
                        0.001056,
                        0.000371,
                        0.000138,
                        6.2e-05,
                        3.8e-05,
                        1.6e-05,
                        3e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000253,
                        0.000419,
                        0.00097,
                        0.002268,
                        0.004615,
                        0.008232,
                        0.012061,
                        0.013764,
                        0.01269,
                        0.00988,
                        0.00641,
                        0.003391,
                        0.001375,
                        0.000352,
                        7e-05,
                        3.9e-05,
                        1.6e-05,
                        3e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000159,
                        0.000333,
                        0.000802,
                        0.001727,
                        0.003427,
                        0.006363,
                        0.010138,
                        0.013505,
                        0.015301,
                        0.014457,
                        0.011223,
                        0.007178,
                        0.00356,
                        0.001263,
                        0.000358,
                        8.7e-05,
                        9e-06,
                        2e-06,
                        0.0,
                        0.0
                    ],
                    [
                        7.5e-05,
                        0.00023,
                        0.000598,
                        0.00123,
                        0.002345,
                        0.004316,
                        0.007261,
                        0.011034,
                        0.014582,
                        0.015942,
                        0.014559,
                        0.011288,
                        0.007231,
                        0.003733,
                        0.001443,
                        0.000304,
                        9e-06,
                        2e-06,
                        0.0,
                        0.0
                    ],
                    [
                        2.7e-05,
                        0.000102,
                        0.0003,
                        0.000684,
                        0.001367,
                        0.002505,
                        0.004362,
                        0.007309,
                        0.010903,
                        0.013882,
                        0.015276,
                        0.014404,
                        0.011428,
                        0.007354,
                        0.003388,
                        0.000935,
                        0.000171,
                        4.6e-05,
                        7e-06,
                        2e-06
                    ],
                    [
                        5e-06,
                        2e-05,
                        9e-05,
                        0.000286,
                        0.000658,
                        0.001226,
                        0.002235,
                        0.004148,
                        0.007018,
                        0.010488,
                        0.013644,
                        0.01502,
                        0.013925,
                        0.010445,
                        0.005801,
                        0.002345,
                        0.000792,
                        0.000218,
                        3.7e-05,
                        1e-05
                    ],
                    [
                        0.0,
                        0.0,
                        2e-05,
                        0.000102,
                        0.000273,
                        0.000549,
                        0.001102,
                        0.00226,
                        0.004239,
                        0.007138,
                        0.010432,
                        0.012966,
                        0.013724,
                        0.011826,
                        0.007974,
                        0.004455,
                        0.002233,
                        0.000958,
                        0.000324,
                        9.2e-05
                    ],
                    [
                        0.0,
                        0.0,
                        1.3e-05,
                        6.3e-05,
                        0.000163,
                        0.000314,
                        0.000611,
                        0.001249,
                        0.002433,
                        0.004383,
                        0.006909,
                        0.009408,
                        0.011056,
                        0.010813,
                        0.008887,
                        0.006737,
                        0.004916,
                        0.003067,
                        0.001322,
                        0.000382
                    ],
                    [
                        0.0,
                        0.0,
                        1.8e-05,
                        8.8e-05,
                        0.000203,
                        0.000312,
                        0.000455,
                        0.000764,
                        0.00138,
                        0.002449,
                        0.003925,
                        0.005568,
                        0.00704,
                        0.007909,
                        0.008149,
                        0.008144,
                        0.007639,
                        0.005738,
                        0.002924,
                        0.001208
                    ],
                    [
                        0.0,
                        0.0,
                        1.8e-05,
                        8.8e-05,
                        0.000198,
                        0.000288,
                        0.000365,
                        0.000502,
                        0.00077,
                        0.001238,
                        0.001911,
                        0.00273,
                        0.003684,
                        0.0048,
                        0.006002,
                        0.007105,
                        0.00758,
                        0.006558,
                        0.004455,
                        0.0031
                    ],
                    [
                        0.0,
                        0.0,
                        9e-06,
                        4.4e-05,
                        0.000105,
                        0.000175,
                        0.000244,
                        0.000316,
                        0.000417,
                        0.000601,
                        0.000889,
                        0.001276,
                        0.001787,
                        0.002479,
                        0.003318,
                        0.004175,
                        0.004909,
                        0.005365,
                        0.00554,
                        0.005586
                    ],
                    [
                        0.0,
                        0.0,
                        2e-06,
                        1.2e-05,
                        3.8e-05,
                        9.6e-05,
                        0.000173,
                        0.000228,
                        0.00027,
                        0.000355,
                        0.000509,
                        0.000729,
                        0.001011,
                        0.001347,
                        0.001743,
                        0.002217,
                        0.002961,
                        0.004339,
                        0.006055,
                        0.007062
                    ]
                ],
                "Assortivity": {
                    "Axes": [
                        "LOW", 
                        "MEDIUM", 
                        "HIGH"
                    ],
                    "Group": "INDIVIDUAL_PROPERTY", 
                    "Property_Name": "Risk", 
                    "Weighting_Matrix_RowMale_ColumnFemale": [
                        [0.6097767084, 0.3902232916, 0], 
                        [0.3902232916, 0.6097767084, 0.6097767084], 
                        [0, 0.6097767084, 0.3902232916]
                    ]
                }
            }
        },
        "TRANSITORY": { 
            "Relationship_Parameters": {
                "Coital_Act_Rate": 0.33,
                "Condom_Usage_Probability": {
                    "Max": 0.6093379311,
                    "Mid": 2006.3329995924,
                    "Min": 0.0,
                    "Rate": 3.0
                },
                "Duration_Weibull_Heterogeneity": 0.833333333,
                "Duration_Weibull_Scale": 0.956774771214,
                "Migration_Actions": [
                    "TERMINATE"
                ],
                "Migration_Actions_Distribution": [
                    1.0
                ]
            },
            "Concurrency_Parameters": {
                "HIGH": {
                    "Max_Simultaneous_Relationships_Female": 1,
                    "Max_Simultaneous_Relationships_Male": 1,
                    "Prob_Extra_Relationship_Female": 1,
                    "Prob_Extra_Relationship_Male": 1
                },
                "LOW": {
                    "Max_Simultaneous_Relationships_Female": 1.5009139604907449,
                    "Max_Simultaneous_Relationships_Male": 1.5009139604907449,
                    "Prob_Extra_Relationship_Female": 0.1370149244245198,
                    "Prob_Extra_Relationship_Male": 0.25977692232616656
                },
                "MEDIUM": {
                    "Max_Simultaneous_Relationships_Female": 2.738368682943356,
                    "Max_Simultaneous_Relationships_Male": 2.738368682943356,
                    "Prob_Extra_Relationship_Female": 0.5837316234889807,
                    "Prob_Extra_Relationship_Male": 0.5876342060719743
                }
            },
            "Pair_Formation_Parameters": {
                "Age_of_First_Bin_Edge_Female": 17.5,
                "Age_of_First_Bin_Edge_Male": 17.5,
                "Number_Age_Bins_Female": 20,
                "Number_Age_Bins_Male": 20,
                "Update_Period": 7,
                "Years_Between_Bin_Edges_Female": 2.5,
                "Years_Between_Bin_Edges_Male": 2.5,
                "Extra_Relational_Rate_Ratio_Female": 10,
                "Extra_Relational_Rate_Ratio_Male": 10,
                "Formation_Rate_Constant": 0.0010478386,
                "Formation_Rate_Type": "CONSTANT",
                "Joint_Probabilities": [
                    [
                        0.045567,
                        0.035956,
                        0.019793,
                        0.007568,
                        0.002328,
                        0.000551,
                        5.9e-05,
                        1.8e-05,
                        4e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.044738,
                        0.036352,
                        0.021958,
                        0.010123,
                        0.003782,
                        0.001001,
                        0.000184,
                        7.3e-05,
                        2.2e-05,
                        4e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.041749,
                        0.037081,
                        0.028094,
                        0.017609,
                        0.00817,
                        0.002469,
                        0.000642,
                        0.000267,
                        9e-05,
                        2.1e-05,
                        2e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.034883,
                        0.034782,
                        0.032721,
                        0.025031,
                        0.013417,
                        0.004969,
                        0.001732,
                        0.000707,
                        0.000251,
                        7.9e-05,
                        1.8e-05,
                        4e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.022317,
                        0.025265,
                        0.028532,
                        0.025516,
                        0.016489,
                        0.008321,
                        0.00378,
                        0.001533,
                        0.000572,
                        0.000213,
                        6.2e-05,
                        1.2e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.0092,
                        0.013361,
                        0.019412,
                        0.020918,
                        0.016811,
                        0.01101,
                        0.005957,
                        0.002611,
                        0.001029,
                        0.000369,
                        0.000102,
                        2e-05,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.002873,
                        0.006137,
                        0.01134,
                        0.014349,
                        0.013829,
                        0.010947,
                        0.00706,
                        0.00372,
                        0.001602,
                        0.000506,
                        0.000122,
                        3.1e-05,
                        4e-06,
                        1e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.00106,
                        0.002528,
                        0.005183,
                        0.007796,
                        0.009413,
                        0.00922,
                        0.007328,
                        0.004767,
                        0.002392,
                        0.000882,
                        0.000305,
                        0.000121,
                        3.8e-05,
                        8e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.000282,
                        0.000827,
                        0.002074,
                        0.00409,
                        0.006305,
                        0.007459,
                        0.00709,
                        0.005534,
                        0.003443,
                        0.001782,
                        0.000873,
                        0.000393,
                        0.00014,
                        3.2e-05,
                        2e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        0.000148,
                        0.000373,
                        0.001016,
                        0.002362,
                        0.004162,
                        0.005612,
                        0.006176,
                        0.005583,
                        0.00412,
                        0.00263,
                        0.001522,
                        0.000769,
                        0.000319,
                        9.7e-05,
                        2.1e-05,
                        4e-06,
                        0.0,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        7.7e-05,
                        0.000166,
                        0.000484,
                        0.001276,
                        0.002467,
                        0.003661,
                        0.004442,
                        0.004384,
                        0.003574,
                        0.002614,
                        0.0018,
                        0.001118,
                        0.000585,
                        0.000245,
                        8.3e-05,
                        2e-05,
                        2e-06,
                        0.0,
                        0.0,
                        0.0
                    ],
                    [
                        9.6e-05,
                        0.000144,
                        0.000302,
                        0.000669,
                        0.001252,
                        0.001963,
                        0.002577,
                        0.002736,
                        0.002445,
                        0.002074,
                        0.00175,
                        0.001355,
                        0.000895,
                        0.000496,
                        0.000222,
                        7.1e-05,
                        1.7e-05,
                        3e-06,
                        0.0,
                        0.0
                    ],
                    [
                        0.000219,
                        0.000202,
                        0.000201,
                        0.000291,
                        0.00054,
                        0.001013,
                        0.001555,
                        0.001784,
                        0.001668,
                        0.001522,
                        0.001453,
                        0.001358,
                        0.00117,
                        0.000855,
                        0.000475,
                        0.000195,
                        6.3e-05,
                        1.3e-05,
                        0.0,
                        0.0
                    ],
                    [
                        0.00032,
                        0.00025,
                        0.000144,
                        9.7e-05,
                        0.000205,
                        0.000567,
                        0.001037,
                        0.00123,
                        0.00111,
                        0.000997,
                        0.001033,
                        0.001178,
                        0.001296,
                        0.00115,
                        0.000755,
                        0.000381,
                        0.00015,
                        3.7e-05,
                        4e-06,
                        1e-06
                    ],
                    [
                        0.000227,
                        0.00017,
                        7.7e-05,
                        1.5e-05,
                        5.1e-05,
                        0.000253,
                        0.000535,
                        0.000648,
                        0.000582,
                        0.00056,
                        0.000678,
                        0.000905,
                        0.001125,
                        0.001143,
                        0.000924,
                        0.000598,
                        0.000283,
                        8.6e-05,
                        2.1e-05,
                        1e-05
                    ],
                    [
                        6.2e-05,
                        4.6e-05,
                        2.1e-05,
                        4e-06,
                        1.4e-05,
                        6.9e-05,
                        0.000146,
                        0.000177,
                        0.000176,
                        0.00024,
                        0.000395,
                        0.0006,
                        0.000804,
                        0.000943,
                        0.000951,
                        0.000756,
                        0.000428,
                        0.000183,
                        8.8e-05,
                        6.3e-05
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        1.5e-05,
                        7.6e-05,
                        0.000194,
                        0.000361,
                        0.000551,
                        0.00072,
                        0.000808,
                        0.000735,
                        0.000536,
                        0.000355,
                        0.000253,
                        0.000212
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        4e-06,
                        2.1e-05,
                        7e-05,
                        0.000186,
                        0.000351,
                        0.000496,
                        0.000586,
                        0.000621,
                        0.000607,
                        0.000555,
                        0.000489,
                        0.000451
                    ],
                    [
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        1.5e-05,
                        7.7e-05,
                        0.000184,
                        0.000305,
                        0.000424,
                        0.000543,
                        0.000649,
                        0.000717,
                        0.000746,
                        0.000754
                    ],
                    [0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        0.0,
                        5e-06,
                        2.4e-05,
                        7.4e-05,
                        0.000178,
                        0.000331,
                        0.0005,
                        0.000666,
                        0.00082,
                        0.000946,
                        0.00101
                     ]
                ],
                "Assortivity": {
                    "Axes": [
                        "LOW", 
                        "MEDIUM", 
                        "HIGH"
                    ], 
                    "Group": "INDIVIDUAL_PROPERTY", 
                    "Property_Name": "Risk", 
                    "Weighting_Matrix_RowMale_ColumnFemale": [
                        [0.6097767084, 0.3902232916, 0], 
                        [0.3902232916, 0.6097767084, 0.6097767084], 
                        [0, 0.6097767084, 0.3902232916]
                    ]
                }
            }
        }
    }
}


[docs]def get_society_dict(society_name: str = None) -> Dict: society_name = 'PFA-Southern-Africa' if society_name is None else society_name if society_name in societies: society = deepcopy(societies[society_name]['Society']) else: raise ValueError(f"Unknown society template: {society_name}") return society