Kids Moving Module

This module simulates the process of children or young adults moving out of their parent’s households. It uses an estimated model to determine which eligible individuals move, and updates the persons and households tables accordingly. The logic ensures that only a subset of eligible children move, and that new households are created for them with appropriate geographic assignments.

Key features:

  • Applies a logit model to eligible children/young adults to predict moving out.

  • Updates household assignments and relationship codes for movers.

  • Ensures movers are assigned to new households and that household-level attributes are updated.

  • Only moves children if their departure does not empty the household (unless all are moving).

  • Designed for use as-is; users should not override orca columns or internal logic.

Caveats:

  • The model only considers persons with specific relate codes (2, 3, 4, 7, 9, 14) and age >= 16.

  • Movers are only reassigned if their departure does not leave the household empty, unless all are moving.

  • Geographic assignment for new households is inherited from the original household.

  • Most errors are silently handled; users should ensure input data is consistent.

Module function

Module configuration options: KidsMovingModuleConfig

demos.models.kids_moving.kids_moving(persons, households, get_new_households)[source]

Simulate children or young adults moving out of their parental households.

This step applies the kids_move estimated model to eligible persons (age >= 16 and specific relate codes) to determine who moves out. Movers are assigned to new households, and both the persons and households tables are updated in place.

Parameters:

  • persons (orca.Table) – The persons table containing individual-level attributes.

  • households (orca.Table) – The households table containing household-level attributes.

  • get_new_households (callable) – Function to generate new unique household IDs as needed.

Return type:

None

Notes

  • Modifies persons.household_id, persons.relate, and households.lcm_county_id in place.

  • Only persons with relate codes [2, 3, 4, 7, 9, 14] and age >= 16 are considered.

  • Movers are only reassigned if their departure does not leave the household empty, unless all are moving.

  • Geographic assignment for new households is inherited from the original household.