The Model Menagerie

This module contains a collection of frequently used parameterizations of disease models.

vivarium_public_health.disease.models.SI(cause)[source]

Create a Susceptible-Infected disease model.

Parameters:

cause (str) – The name of the cause of disease.

Return type:

DiseaseModel

Returns:

A configured SI disease model.

vivarium_public_health.disease.models.SIR(cause)[source]

Create a Susceptible-Infected-Recovered disease model.

Parameters:

cause (str) – The name of the cause of disease.

Return type:

DiseaseModel

Returns:

A configured SIR disease model.

vivarium_public_health.disease.models.SIS(cause)[source]

Create a Susceptible-Infected-Susceptible disease model.

Parameters:

cause (str) – The name of the cause of disease.

Return type:

DiseaseModel

Returns:

A configured SIS disease model.

vivarium_public_health.disease.models.SIS_fixed_duration(cause, duration)[source]

Create an SIS disease model with a fixed infection duration.

Parameters:
  • cause (str) – The name of the cause of disease.

  • duration (str) – The duration of infection in days.

Return type:

DiseaseModel

Returns:

A configured SIS disease model with fixed duration.

vivarium_public_health.disease.models.SIR_fixed_duration(cause, duration)[source]

Create an SIR disease model with a fixed infection duration.

Parameters:
  • cause (str) – The name of the cause of disease.

  • duration (str) – The duration of infection in days.

Return type:

DiseaseModel

Returns:

A configured SIR disease model with fixed duration.

vivarium_public_health.disease.models.NeonatalSWC_without_incidence(cause)[source]

Create a neonatal model with birth prevalence but no incidence.

Parameters:

cause (str) – The name of the cause of disease.

Return type:

DiseaseModel

Returns:

A configured neonatal disease model without incidence.

vivarium_public_health.disease.models.NeonatalSWC_with_incidence(cause)[source]

Create a neonatal model with both birth prevalence and incidence.

Parameters:

cause (str) – The name of the cause of disease.

Return type:

DiseaseModel

Returns:

A configured neonatal disease model with incidence.