Initial proof of concept to plot plan

Makes use of our 'output' and the 'forecast'
to plot a timeseries of the CI alongside
highlights for the CI of running now or running
at the optimal time.

Author: andreww

cats/__init__.py

@@ -15,6 +15,7 @@
 from .forecast import CarbonIntensityAverageEstimate
 from .optimise_starttime import get_avg_estimates  # noqa: F401
 from .constants import CATS_ASCII_BANNER_COLOUR, CATS_ASCII_BANNER_NO_COLOUR
+from .plotting import plotplan
 
 __version__ = "1.0.0"
 
@@ -193,6 +194,11 @@ def positive_integer(string):
         action="store_true",
         help="Disable all terminal output colouring (alias to --no-colour)",
     )
+    parser.add_argument(
+        "--plot",
+        help="Create a plot of the forcast and optimised plan for the job",
+        action="store_true",
+    )
 
     return parser
 
@@ -360,6 +366,8 @@ def main(arguments=None) -> int:
         print(output.to_json(dateformat, sort_keys=True, indent=2))
     else:
         print(output)
+    if args.plot:
+        plotplan(CI_forecast, output)
     if args.command and args.scheduler == "at":
         if err := schedule_at(output, args.command.split()):
             print(err)

cats/plotting.py

@@ -0,0 +1,38 @@
+import numpy as np
+import matplotlib.pyplot as plt
+
+def plotplan(CI_forecast, output):
+    """
+    Plot the carbon intensity forcast and optimised plan
+    """
+    # Just for now pull the CI forecast apart... probably belongs as method...
+    values = []
+    times = []
+    now_values = []
+    now_times = []
+    opt_values = []
+    opt_times = []
+    for point in CI_forecast:
+        values.append(point.value)
+        times.append(point.datetime)
+        if (point.datetime >= output.carbonIntensityOptimal.start and
+            point.datetime <= output.carbonIntensityOptimal.end):
+            opt_values.append(point.value)
+            opt_times.append(point.datetime)
+        if (point.datetime >= output.carbonIntensityNow.start and
+            point.datetime <= output.carbonIntensityNow.end):
+            now_values.append(point.value)
+            now_times.append(point.datetime)
+
+    # Make the plot (should probably take fig and ax as opt args...)
+    fig, ax = plt.subplots()
+    ax.fill_between(times, 0.0, values, alpha=0.2, color='b')
+    ax.fill_between(now_times, 0.0, now_values, alpha=0.6,  color='r')
+    ax.fill_between(opt_times, 0.0, opt_values, alpha=0.6, color='g')
+    ax.set_xlabel("Time (mm-dd hh)")
+    ax.set_ylabel("Forecast carbon intensity (gCO2eq/kWh)")
+    ax.grid(True)
+    ax.label_outer()
+    fig.autofmt_xdate()
+    plt.show()
+    return None