polaris.runs.convergence.workplace_stabilization_config.WorkplaceStabilizationConfig

polaris.runs.convergence.workplace_stabilization_config.WorkplaceStabilizationConfig#

pydantic model polaris.runs.convergence.workplace_stabilization_config.WorkplaceStabilizationConfig#

Bases: BaseModel

Configuration class for the POLARIS workplace stabilization process.

Workplace stabilization in POLARIS is the process by which long-term decisions regarding work location are introduced to an overall iterative process. Work places are allowed to be updated based on current congestion conditions on specified iterations, a number of iterations are then run using those updated choices to allow the congestion to stabilize before repeating the process.

Show JSON schema
{
   "title": "WorkplaceStabilizationConfig",
   "description": "Configuration class for the POLARIS workplace stabilization process.\n\nWorkplace stabilization in POLARIS is the process by which long-term decisions regarding work location\nare introduced to an overall iterative process. Work places are allowed to be updated based on current\ncongestion conditions on specified iterations, a number of iterations are then run using those updated\nchoices to allow the congestion to stabilize before repeating the process.",
   "type": "object",
   "properties": {
      "enabled": {
         "default": false,
         "title": "Enabled",
         "type": "boolean"
      },
      "first_workplace_choice_iteration": {
         "default": 1,
         "title": "First Workplace Choice Iteration",
         "type": "integer"
      },
      "choose_workplaces_every_x_iter": {
         "default": 5,
         "title": "Choose Workplaces Every X Iter",
         "type": "integer"
      },
      "last_workplace_choice_iteration": {
         "default": 31,
         "title": "Last Workplace Choice Iteration",
         "type": "integer"
      }
   }
}

Fields:
field enabled: bool = False#

Flag which controls if any workpalce stabilization will be undertaken during the model run

field first_workplace_choice_iteration: int = 1#

The first iteration at which workplace choice should be allowed (i.e. start)

field choose_workplaces_every_x_iter: int = 5#

The number of iterations between workplace choice iterations (i.e. step)

field last_workplace_choice_iteration: int = 31#

Last iteration at which it is possible to choose work places, note that workplace choice is not guaranteed to happen at this iteration unless it is specified by the start and step parameters.

should_choose_workplaces(iteration)#
number_of_prior_workplaces_iteration(i: int) → float#