rsvsim.parameters module

Set the parameters for rsvsim.

rsvsim.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)

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

Helper function to set layer-specific parameters. If layer keys are not provided, then set them based on the population type. This function is not usually called directly by the user, although it can sometimes be used to fix layer key mismatches (i.e. if the contact layers in the population do not match the parameters). More commonly, however, mismatches need to be fixed explicitly.

Parameters

• pars (dict) – the parameters dictionary

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

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

rsvsim.parameters.get_prognoses()

Return the default parameter values for prognoses

The prognosis probabilities are conditional given the previous disease state.

Returns

the dictionary of prognosis probabilities

Return type

prog_pars (dict)

rsvsim.parameters.get_genotype_choices()

Define valid pre-defined genotype names

rsvsim.parameters.get_vaccine_choices()

Define valid pre-defined vaccine names