metawards.utils.scale_link_susceptibles

metawards.utils.scale_link_susceptibles(links: Links, ratio: any)

Scale the number of susceptibles in the passed Links by the passed scale ratio. This can be a value, e.g. ratio = 2.0 will scale the total number of susceptibles by 2.0. This can also be lists of values, where ward[i] will be scaled by ratio[i]. They can also be dictionaries, e.g. ward[i] scaled by ratio[i]

Parameters

ratio (None, float, list or dict) – The amount by which to scale the total population of susceptibles - evenly scales the work and play populations

Returns

Return type

None