Skip to content

epymorph.data.ipm.sparsemod

Defines a copmartmental IPM mirroring the SPARSEMOD COVID model.

SparseMod

Bases: CompartmentModel

A model similar to one used in sparsemod.

compartments class-attribute instance-attribute

compartments = [
    compartment("S", description="susceptible"),
    compartment("E", description="exposed"),
    compartment("I_a", description="infected asymptomatic"),
    compartment(
        "I_p", description="infected presymptomatic"
    ),
    compartment("I_s", description="infected symptomatic"),
    compartment("I_b", description="infected bed-rest"),
    compartment("I_h", description="infected hospitalized"),
    compartment("I_c1", description="infected in ICU"),
    compartment(
        "I_c2", description="infected in ICU Step-Down"
    ),
    compartment("D", description="deceased"),
    compartment("R", description="recovered"),
]

The compartments of the model.

requirements class-attribute instance-attribute

requirements = [
    AttributeDef("beta", type=float, shape=TxN),
    AttributeDef("omega_1", type=float, shape=TxN),
    AttributeDef("omega_2", type=float, shape=TxN),
    AttributeDef("delta_1", type=float, shape=TxN),
    AttributeDef("delta_2", type=float, shape=TxN),
    AttributeDef("delta_3", type=float, shape=TxN),
    AttributeDef("delta_4", type=float, shape=TxN),
    AttributeDef("delta_5", type=float, shape=TxN),
    AttributeDef("gamma_a", type=float, shape=TxN),
    AttributeDef("gamma_b", type=float, shape=TxN),
    AttributeDef("gamma_c", type=float, shape=TxN),
    AttributeDef("rho_1", type=float, shape=TxN),
    AttributeDef("rho_2", type=float, shape=TxN),
    AttributeDef("rho_3", type=float, shape=TxN),
    AttributeDef("rho_4", type=float, shape=TxN),
    AttributeDef("rho_5", type=float, shape=TxN),
]

The attributes required by the model.

edges

edges(symbols)

When implementing a CompartmentModel, override this method to define the transition edges between compartments.

Parameters:

  • symbols (ModelSymbols) –

    An object containing the symbols in the model for use in declaring edges. These include compartments and data requirements.

Returns: