Initialization

The class is initialized by passing the following arguments:

probabilities

- A fully qualified name of the module that implements computing relocation probabilities. The module should be a child of the opus_core class Probabilities.

choices

- A fully qualified name of the module that implements choosing agents for relocation according to given probabilities. The module should be a child of the opus_core class Choices. Default value is ``opus_core.random_choices'' (see Section 7.6.3).

location_id_name

- Name of the attribute that specifies locations. It must be a primary attribute of the agent set. Default value is ``grid_id''.

model_name

- Name of the model. Default value is ``Agent Relocation Model''.

The initialization method creates a class attribute upc_sequence, using the passed arguments probabilities and choices. It is an object of class upc_sequence where the utilities component is set to None (see Section 7.6.4).