preheat_open.api.mocks.CCYearlyPeriodic

class preheat_open.api.mocks.CCYearlyPeriodic(amplitude=1.0, day_of_year_top=182.5)

Bases: ComponentCharacteristic

Component characteristic that adds yearly periodic variation.

__init__(amplitude=1.0, day_of_year_top=182.5)

Initialize CCYearlyPeriodic.

Parameters:
  • amplitude (float) – Amplitude of the periodic variation

  • day_of_year_top (float) – Day of year when the sine wave peaks

Methods

__init__([amplitude, day_of_year_top])

Initialize CCYearlyPeriodic.

mock(data)

rtype:

Series