parameters
parameters
Set parameters
Classes
| Name | Description |
|---|---|
| SimPars | Simulation-level parameters with STIsim-specific defaults. |
SimPars
parameters.SimPars(**kwargs)Simulation-level parameters with STIsim-specific defaults.
Extends Starsim’s ss.SimPars with defaults suited to STI modeling: monthly timesteps, year-2000 start, year-2030 end, and optional pregnancy and migration modules.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| n_agents | int | Number of agents (default 1000). | required |
| start | float | Simulation start year (default 2000). | required |
| stop | float | Simulation end year (default 2030). | required |
| dur | float | Duration in years; used if stop is not set. |
required |
| dt | float | Timestep in years (default 1/12, i.e. monthly). | required |
| rand_seed | int | Random seed (default 1). | required |
| use_pregnancy | bool | Enable the pregnancy module (default True). | required |
| use_migration | bool | Enable the migration module (default False). | required |
| **kwargs | Any additional parameter overrides. | {} |
Functions
| Name | Description |
|---|---|
| connector_register | Auto-discoverable connectors keyed by <d1>_<d2>. Only includes |
| dem_pars | Return a dictionary with all parameters used within demographic modules |
| make_sti | Create an STI disease module based on the name and parameters provided. |
| merged_connector_pars | Merge all parameters from auto-discoverable connectors. |
| merged_sti_pars | Merge all the parameters from the STI disease modules |
| mergepars | Merge all parameter dictionaries into a single dictionary. |
| sti_aliases | Define aliases for STIs |
| sti_register | Registry of STI names linked to disease classes |
connector_register
parameters.connector_register()Auto-discoverable connectors keyed by <d1>_<d2>. Only includes connectors that follow the (disease1_module, disease2_module, ...) constructor convention, so sti.Sim can build them automatically from a disease list.
dem_pars
parameters.dem_pars()Return a dictionary with all parameters used within demographic modules
make_sti
parameters.make_sti(name, pars=None)Create an STI disease module based on the name and parameters provided.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| name | str | Name of the STI disease module to create. | required |
| pars | dict | Parameters to initialize the disease module with. | None |
Returns
| Name | Type | Description |
|---|---|---|
| ss.Disease: An instance of the specified STI disease module. |
merged_connector_pars
parameters.merged_connector_pars()Merge all parameters from auto-discoverable connectors.
merged_sti_pars
parameters.merged_sti_pars()Merge all the parameters from the STI disease modules
mergepars
parameters.mergepars(*args)Merge all parameter dictionaries into a single dictionary. This is used to initialize the SimPars class with all relevant parameters. It wraps the sc.mergedicts function to ensure all inputs are dicts
sti_aliases
parameters.sti_aliases()Define aliases for STIs
sti_register
parameters.sti_register(key=None)Registry of STI names linked to disease classes