load_households

popo.profiles.synthetic.load_households(zip_path, index, n)

Stream a Low Carbon London-format TSF zip and take the first n full-year series.

Values are kWh per half hour in the source; they are converted to kW and normalised to a per-unit shape of mean 1.0 so a caller can scale each customer to its own annual consumption.

Parameters:

• zip_path (Path) – Path to the dataset zip, containing one .tsf member whose @data section holds one name:start:values line per series.

• index (DatetimeIndex) – Target calendar; each kept series is aligned to start on the same weekday as index[0] and trimmed to len(index) steps.

• n (int) – Number of series to keep.

Return type:

DataFrame

Returns:

A frame of shape (len(index), kept), columns named by series id, each column mean 1.0.

Raises:

RuntimeError – If no series in the archive covers a full year.