SimPars

class SimPars(**kwargs)

Bases: Pars

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 = ss.Sim() and then inspect sim.pars, rather than calling this function directly.

Parameters:

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

Methods

is_default(key)

Check if the provided value matches the default

validate()

Call parameter validation methods

validate_sim_pars()

Validate each of the parameter values

validate_verbose()

Validate verbosity

validate_agents()

Check that n_agents is supplied and convert to an integer

validate_total_pop()

Ensure one but not both of total_pop and pop_scale are defined

validate_time()

Ensure at least one of dur and stop is defined, but not both

validate_modules()

Validate modules passed in pars

validate_demographics()

Validate demographics-related input parameters

validate_networks()

Validate networks

convert_modules()

Convert different types of representations for modules into a standardized object representation that can be parsed and used by a Sim object. Used for starsim classes: - networks, - demographics, - diseases, - analyzers, - interventions, and - connectors.