household_projections#

caf.van.lgv_inputs.household_projections(occupied_paths, zone_lookup, unoccupied_paths=None)[source]#

Reads and aggregates the household DVectors and converts to model zone system.

No specific segmentation is required for the DVectors since the data is aggregated to households per zone.

Parameters:

  • occupied_paths (Path) – Path to Occupied Dwellings DVector.

  • zone_lookup (Path) – Path to the zone correspondence CSV.

  • unoccupied_paths (Optional[Path], optional) – Path to Occupied Dwellings DVector. If None then only the occupied dwellings are used to calculate households. None by default.

Returns:

Household projections in the model zone system with columns ‘Zone’ and ‘Households’.

Return type:

pd.DataFrame