diseases.gud
diseases.gud
Placeholder modules for non-specific STIs, including: - Genital ulcer disease - Vaginal discharge
Classes
| Name | Description |
|---|---|
| GUD | Genital ulcer disease (GUD) module. |
| GUDPlaceholder | Placeholder for background prevalence of genital ulcerative disease. |
| Placeholder | Simple placeholder disease module for testing connectors. |
| VDPlaceholder | Placeholder for background prevalence of vaginal discharge. |
GUD
diseases.gud.GUD(pars=None, init_prev_data=None, **kwargs)Genital ulcer disease (GUD) module.
Models GUD as a simple SIS infection with a lognormal duration of infectiousness and spontaneous recovery. Typically used alongside a syphilis connector that drives GUD prevalence from active syphilis cases.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| pars | dict | Override default parameters (dur_inf, beta, init_prev). | None |
| init_prev_data | Optional initial prevalence data by age/sex/risk group. | None |
|
| **kwargs | Additional parameters passed to update_pars. |
{} |
Methods
| Name | Description |
|---|---|
| set_prognoses | Set initial prognoses for adults newly infected with syphilis |
| step_state | Update states |
set_prognoses
diseases.gud.GUD.set_prognoses(uids, source_uids=None)Set initial prognoses for adults newly infected with syphilis
step_state
diseases.gud.GUD.step_state()Update states
GUDPlaceholder
diseases.gud.GUDPlaceholder(pars=None, name='gud', **kwargs)Placeholder for background prevalence of genital ulcerative disease.
Placeholder
diseases.gud.Placeholder(pars=None, name=None, **kwargs)Simple placeholder disease module for testing connectors.
Maintains a target prevalence by probabilistically adding or removing symptomatic agents each timestep. Useful for testing disease interaction connectors without a full transmission model.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| pars | dict | Override default parameters (prevalence, care_seeking). | None |
| name | str | Module name. | None |
| **kwargs | Additional parameters passed to update_pars. |
{} |
Methods
| Name | Description |
|---|---|
| step | When using a connector to the syphilis module, this is not needed. The connector should update the syphilis-positive state. |
step
diseases.gud.Placeholder.step()When using a connector to the syphilis module, this is not needed. The connector should update the syphilis-positive state.
VDPlaceholder
diseases.gud.VDPlaceholder(pars=None, name='vd', **kwargs)Placeholder for background prevalence of vaginal discharge.