Adds ability to scale a schedule

archetypal/schedule.py

@@ -1316,6 +1316,14 @@ def startDate(self):
         year = get_year_for_first_weekday(self.startDayOfTheWeek)
         return datetime(year, 1, 1)
 
+    def scale(self, diversity=0.1):
+        """Scale the schedule values by a diversity factor around the average."""
+        average = np.average(self.Values)
+        new_values = ((average - self.Values) * diversity) + self.Values
+
+        self.Values = new_values
+        return self
+
     def plot(self, **kwargs):
         """Plot the schedule. Implements the .loc accessor on the series object.
 

tests/test_schedules.py

@@ -47,6 +47,14 @@ def schedules_in_necb_specific(self, config):
         s = Schedule.from_epbunch(epbunch, start_day_of_the_week=0)
         yield s
 
+    def test_scale(self, schedules_in_necb_specific):
+        before_sum = sum(schedules_in_necb_specific.Values)
+        ax = schedules_in_necb_specific.series.iloc[0:24].plot()
+        assert pytest.approx(
+            before_sum, sum(schedules_in_necb_specific.scale(0.1).Values)
+        )
+        schedules_in_necb_specific.series.iloc[0:24].plot(ax=ax)
+
     def test_plot(self, schedules_in_necb_specific):
         schedules_in_necb_specific.plot(drawstyle="steps-post")