traveler.steps.SampleHouseholds.run_via_polars

SampleHouseholds.run_via_polars(store)

Sample households and related records using Polars.

Parameters:

store (GeneralStore) – Store containing households, persons, and optional tours.

Returns:

New store containing the sampled households and their related records. The original store is returned when the requested sample is larger than the population.

Return type:

GeneralStore

Warns:

UserWarning – If the requested sample is larger than the household population.