Skip to content

laser.generic.model

laser.generic.model

laser.generic.model.Model(scenario, params, birthrates=None, name='generic', skip_capacity=False, states=None, additional_states=None)

Initialize the SI model.

Parameters:

Name Type Description Default
scenario GeoDataFrame

The scenario data containing per patch population, initial S and I counts, and geometry.

required
params PropertySet

The parameters for the model, including 'nticks' and 'beta'.

required
birthrates ndarray

Birth rates in CBR per patch per tick. Defaults to None.

None
name str

Name of the model instance. Defaults to "generic".

'generic'
skip_capacity bool

If True, skips capacity checks. Defaults to False.

False
states list

List of state names. Defaults to None == {"S", "E", "I", "R"}.

None
additional_states list

List of additional state names. Defaults to None.

None