breos.load_profiles.load_profile#

breos.load_profiles.load_profile(profile_type, annual_consumption_kwh, start_date='2025-01-01', freq='h', num_years=1, rlp_directory=None, timezone='UTC')[source]#

Load and scale a residential/commercial load profile.

This is the main function for loading load profiles. It supports the bundled H0SLP demandlib profile, user-supplied external CSVs through rlp_directory, scaling to target annual consumption, multi-year extension, and hourly or 15-minute output.

Parameters:

  • profile_type (str) – Profile type key (see PROFILE_NAMES) or name

  • annual_consumption_kwh (float) – Target annual consumption in kWh

  • start_date (str) – Start date for the profile (YYYY-MM-DD)

  • freq (str) – Time frequency (‘h’ for hourly, ‘15min’ for 15-minute)

  • num_years (int) – Number of years to generate

  • rlp_directory (Optional[str]) – Directory containing RLP files. When omitted, BREOS uses only redistributable packaged profiles.

  • timezone (Optional[str]) – Timezone for the index. Profile rows are wall-clock local behavior (H0 morning/evening peaks), so pass the location’s timezone to pin them to local time; the simulation aligns load and PV by UTC instant. The ‘UTC’ default keeps the legacy UTC-clock convention for callers without a location.

Return type:

DataFrame

Returns:

DataFrame with ‘Electrical Consumption [W]’ column and DatetimeIndex

Raises:

ValueError – If profile_type is not recognized