covasim.parameters module

Set the parameters for Covasim.

covasim.parameters.make_pars(set_prognoses=False, prog_by_age=True, **kwargs)

Create the parameters for the simulation. Typically, this function is used internally rather than called by the user; e.g. typical use would be to do sim = cv.Sim() and then inspect sim.pars, rather than calling this function directly.

Parameters

• set_prognoses (bool) – whether or not to create prognoses (else, added when the population is created)

• prog_by_age (bool) – whether or not to use age-based severity, mortality etc.

• kwargs (dict) – any additional kwargs are interpreted as parameter names

Returns

the parameters of the simulation

Return type

pars (dict)

covasim.parameters.reset_layer_pars(pars, layer_keys=None, force=False)

Small helper function to set layer-specific parameters. If layer keys are not provided, then set them based on the population type.

Parameters

• pars (dict) – the parameters dictionary

• layer_keys (list) – the layer keys of the population, if available

• force (bool) – reset the pars even if they already exist

covasim.parameters.get_prognoses(by_age=True)

Return the default parameter values for prognoses

The prognosis probabilities are conditional given the previous disease state.

Parameters

by_age (bool) – whether or not to use age-specific values

Returns

the dictionary of prognosis probabilities

Return type

prog_pars (dict)