InfectionSeedingProcess#

class InfectionSeedingProcess(model, verbose=False, params=None)[source]#

Bases: BaseComponent

Component for seeding initial infections in the compartmental model.

This component initializes infections by moving individuals from the Susceptible (S) compartment to the Infected (I) compartment. It can either:

  1. Automatically seed the patch with the largest population (default)

  2. Seed specific patches provided by the user

The seeding occurs during initialize() before the simulation begins.

Parameters:

  • model (BaseLaserModel) – The compartmental model instance.

  • verbose (bool) – Whether to print verbose output during initialization.

  • params (InfectionSeedingParams | None) – Component-specific parameters. If None, uses default parameters.

Example

# Seed 1 infection in largest patch (default)
seeding_params = InfectionSeedingParams()

# Seed 5 infections in largest patch
seeding_params = InfectionSeedingParams(num_infections=5)

# Seed specific patches with same number of infections
seeding_params = InfectionSeedingParams(
    target_patches=["nigeria:kano:kano:A0001", "nigeria:kano:kano:A0002"],
    infections_per_patch=3,
)

# Seed specific patches with different numbers of infections
seeding_params = InfectionSeedingParams(
    target_patches=["nigeria:kano:kano:A0001", "nigeria:kano:kano:A0002"],
    infections_per_patch=[5, 2],
)

Initialize the component.

Parameters:

  • model (BaseLaserModel) – The model instance this component belongs to.

  • verbose (bool) – Whether to enable verbose output. Defaults to False.