Skip to content

epymorph.data.ipm.pei

Defines a compartmental IPM mirroring the Pei paper's beta treatment.

Pei

Bases: CompartmentModel

The 'pei' IPM: an SIRS model driven by humidity.

compartments class-attribute instance-attribute

compartments = [
    compartment("S"),
    compartment("I"),
    compartment("R"),
]

The compartments of the model.

requirements class-attribute instance-attribute

requirements = [
    AttributeDef("infection_duration", float, TxN),
    AttributeDef("immunity_duration", float, TxN),
    AttributeDef("humidity", float, 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: