ModelSURV

Contents

ModelSURV#

class epiworldpy.epimodels.ModelSURV(self: epiworldpy._core.epimodels.ModelSURV, name: str, prevalence: SupportsInt | SupportsIndex, efficacy_vax: SupportsFloat | SupportsIndex, latent_period: SupportsFloat | SupportsIndex, infect_period: SupportsFloat | SupportsIndex, prob_symptoms: SupportsFloat | SupportsIndex, prop_vaccinated: SupportsFloat | SupportsIndex, prop_vax_redux_transm: SupportsFloat | SupportsIndex, prop_vax_redux_infect: SupportsFloat | SupportsIndex, surveillance_prob: SupportsFloat | SupportsIndex, transmission_rate: SupportsFloat | SupportsIndex, prob_death: SupportsFloat | SupportsIndex, prob_noreinfect: SupportsFloat | SupportsIndex)#

Bases: Model

Surveillance (SURV) model, where agents may be tested and isolated even without symptoms.

A share of the population is vaccinated, infected agents may or may not develop symptoms, and agents are tested at random.

States: Susceptible, Latent, Symptomatic, Symptomatic isolated, Asymptomatic, Asymptomatic isolated, Recovered, Removed.

The model has no agents until a population is added, for example with agents_smallworld().

Create a SURV model.

Parameters:
  • name (str) – Name of the virus.

  • prevalence (int) – Initial number of agents with the virus.

  • efficacy_vax (float) – Efficacy of the vaccine: 1 minus the probability that a vaccinated agent acquires the disease.

  • latent_period (float) – Shape of a Gamma(latent_period, 1) distribution: the expected number of latent days.

  • infect_period (float) – Shape of a Gamma(infect_period, 1) distribution: the expected number of infectious days.

  • prob_symptoms (float) – Probability of developing symptoms.

  • prop_vaccinated (float) – Proportion of agents vaccinated at the start.

  • prop_vax_redux_transm (float) – Factor by which the vaccine reduces transmissibility.

  • prop_vax_redux_infect (float) – Factor by which the vaccine reduces the chance of becoming infected.

  • surveillance_prob (float) – Daily probability of testing an agent.

  • transmission_rate (float) – Probability of transmission per contact.

  • prob_death (float) – Daily probability of death for symptomatic agents.

  • prob_noreinfect (float) – Probability that a recovered agent cannot be infected again.