All global statistics

src/main/scala/DataModels.scala

@@ -36,7 +36,7 @@ case class HourlyElectricityProductionAndConsumption(
     consumption: Power.MW // Mean power consumed
 )
 
-/** Max necessary power to cover peak consumption and temprature, dayly */
+/** Max necessary power to cover peak consumption and temprature, daily */
 case class DailyPowerPeakWithTemperature(
     date: LocalDate,
     powerPeak: Power.MW,

src/main/scala/Main.scala

@@ -3,13 +3,33 @@ import zio.Console._
 
 import DataLoader._
 import UI._
+import java.time.LocalDate
 
 object Main extends ZIOAppDefault {
 
   override def run: ZIO[Any & (ZIOAppArgs & Scope), Any, Unit] = {
     for {
       data <- loadData
-      _    <- consoleLoop(data)
+      _ <- printLine(
+        GlobalStatisticsAnalysis.formatStatisticsTable(
+          "Environmental impact of electricity production and consumption",
+          GlobalStatisticsAnalysis.getCarbonIntensityStatistics(data, LocalDate.of(2022, 1, 1), LocalDate.of(2022, 12, 31))
+        )
+      )
+      _ <- printLine(
+        "\n\n" +
+          GlobalStatisticsAnalysis.formatStatisticsTable(
+            "Electricty consumption and temperature",
+            GlobalStatisticsAnalysis.getTemperatureAndConsumptionStatistics(data, LocalDate.of(2022, 1, 1), LocalDate.of(2022, 12, 31))
+          )
+      )
+      _ <- printLine(
+        "\n\n" +
+          GlobalStatisticsAnalysis.formatStatisticsTable(
+            "Production (MW) by supply chain",
+            GlobalStatisticsAnalysis.getProductionBySupplyChain(data, LocalDate.of(2022, 1, 1), LocalDate.of(2022, 12, 31))
+          )
+      )
     } yield ()
   }
 }

src/main/scala/Types.scala

@@ -2,24 +2,24 @@ import scala.Conversion
 
 object Types {
 
-  opaque type Percentage = Float
+  type Percentage = Float
   given Conversion[Float, Percentage] = Percentage(_)
   object Percentage {
     def apply(value: Float): Percentage = value
   }
 
   object CarbonIntensity {
-    opaque type gPerkWh = Float
+    type gPerkWh = Float
     given Conversion[Float, gPerkWh] = gPerkWh(_)
     object gPerkWh {
       def apply(value: Float): gPerkWh = value
     }
   }
 
   object Power {
-    opaque type kW = Float
-    opaque type MW = Float
-    opaque type GW = Float
+    type kW = Float
+    type MW = Float
+    type GW = Float
 
     object kW {
       def apply(value: Float): kW = value
@@ -49,9 +49,9 @@ object Types {
   }
 
   object Consumption {
-    opaque type kWh = Float
-    opaque type MWh = Float
-    opaque type GWh = Float
+    type kWh = Float
+    type MWh = Float
+    type GWh = Float
 
     object kWh {
       def apply(value: Float): kWh = value
@@ -81,7 +81,7 @@ object Types {
   }
 
   object Temperature {
-    opaque type Celsius = Float
+    type Celsius = Float
 
     object Celsius {
       def apply(value: Float): Celsius = value

src/main/scala/analysis/GlobalStatisticsAnalysis.scala

@@ -1,5 +1,215 @@
 import zio.Chunk
 import Types.*
 import java.time.LocalDate
+import scala.math.Ordering
 
-object GlobalStatisticsAnalysis {}
+object GlobalStatisticsAnalysis {
+
+  /** Global statistics on the carbon intensity of electricity production and consumption.
+    */
+  final case class Statistics(
+      variableName: String,
+      average: Double,
+      standardDeviation: Double,
+      min: Double,
+      max: Double,
+      numberOfPoints: Int
+  )
+
+  final case class FieldSelector[A](
+      fieldName: String,
+      fieldSelector: A => Float
+  )
+
+  /** Get global statistics on given fields, during a given period.
+    *
+    * @param data:
+    *   LoadedData. The data to analyse.
+    * @param fields:
+    *   The fields to analyse.
+    * @param dateSelector:
+    *   The function to select the date from the data.
+    * @param start:
+    *   LocalDate. The start date of the period.
+    * @param end:
+    *   LocalDate. The end date of the period.
+    * @return
+    *   The global statistics on the period.
+    */
+  def getFieldsStatistics[A](
+      data: Chunk[A],
+      fields: List[FieldSelector[A]],
+      dateSelector: A => LocalDate,
+      start: LocalDate,
+      end: LocalDate
+  ): List[Statistics] = {
+
+    val filteredData = data.filter { x =>
+      val date = dateSelector(x)
+      (date.isAfter(start) || date.isEqual(start)) && (date.isBefore(end) || date.isEqual(end))
+    }
+
+    fields.map { field =>
+      val fieldName = field.fieldName
+      val values    = filteredData.map(field.fieldSelector)
+      val average   = ChunkMath.average(values)
+      val stdDev    = ChunkMath.standardDeviation(values)
+      val min       = values.min
+      val max       = values.max
+      val count     = values.size
+
+      Statistics(fieldName, average, stdDev, min, max, count)
+    }.toList
+  }
+
+  /** Get a formatted table of statistics.
+    *
+    * @param title
+    *   The title of the table.
+    * @param statisticsList
+    *   The list of statistics.
+    * @param footer
+    *   The footer of the table.
+    * @return
+    *   A formatted table of statistics.
+    */
+  def formatStatisticsTable(title: String, statisticsList: List[Statistics], footer: String = ""): String = {
+
+    /** Format a statistics row.
+      */
+    def formatStatisticsRow(statistics: Statistics): String = {
+      val fieldName = statistics.variableName
+      val min       = statistics.min
+      val max       = statistics.max
+      val average   = statistics.average
+      val stdDev    = statistics.standardDeviation
+      val count     = statistics.numberOfPoints
+
+      f"| $fieldName%-48s | $min%8.2f | $max%8.2f | $average%8.2f | $stdDev%8.2f | $count%8d |\n"
+        + "+--------------------------------------------------+----------+----------+----------+----------+----------+\n"
+    }
+
+    val addPadding           = title.size % 2
+    val sidePadding          = (102 - title.size) / 2
+    val correctedSidePadding = if (sidePadding < 0) 0 else sidePadding
+    val titleFormatted =
+      "+---------------------------------------------------------------------------------------------------------+\n"
+        + "| " + " " * (correctedSidePadding + addPadding) + title + " " * (correctedSidePadding + 1) + " |\n"
+
+    val header =
+      "+--------------------------------------------------+----------+----------+----------+----------+----------+\n"
+        + "| Field                                            | Min      | Max      | Average  | Std Dev  | Nb pts   |\n"
+        + "+--------------------------------------------------+----------+----------+----------+----------+----------+\n"
+
+    val rows = statisticsList.map(formatStatisticsRow).mkString
+
+    titleFormatted + header + rows + " " + footer
+  }
+
+  /** Get global statistics on the carbon intensity of electricity production and consumption.
+    *
+    * @param data:
+    *   The data to analyse.
+    * @param start:
+    *   The start date of the period.
+    * @param end:
+    *   The end date of the period.
+    * @return
+    *   The global statistics on the period.
+    */
+  def getCarbonIntensityStatistics(data: LoadedData, start: LocalDate, end: LocalDate): List[Statistics] = {
+    val fields = List(
+      FieldSelector("Direct Carbon intensity (gCO2 eq / kWh)", (_: HourlyCarbonIntensity).directIntensity),
+      FieldSelector("LCA Intensity (gCO2 eq / kWh)", (_: HourlyCarbonIntensity).lcaIntensity),
+      FieldSelector("Low carbon percent", (_: HourlyCarbonIntensity).lowCarbonPercent),
+      FieldSelector("Renewable percent", (_: HourlyCarbonIntensity).renewablePercent)
+    )
+
+    getFieldsStatistics(data.hourlyCarbonIntensity, fields, (_: HourlyCarbonIntensity).dateTime.toLocalDate, start, end)
+  }
+
+  /** Get global statistics on the production by supply chain.
+    *
+    * @param data
+    *   The data to analyse.
+    * @param start
+    *   The start date of the period.
+    * @param end
+    *   The end date of the period.
+    * @return
+    *   The global statistics on the period.
+    */
+  def getProductionBySupplyChain(
+      data: LoadedData,
+      start: LocalDate,
+      end: LocalDate
+  ): List[Statistics] = {
+
+    val supplyChains = List(
+      SupplyChain.Fuel,
+      SupplyChain.Coal,
+      SupplyChain.Gas,
+      SupplyChain.Nuclear,
+      SupplyChain.Wind,
+      SupplyChain.Solar,
+      SupplyChain.Hydro,
+      SupplyChain.Bio
+    )
+
+    val productionBySupplyChainFields = supplyChains.map { supplyChain =>
+      FieldSelector(
+        supplyChain.toString,
+        (x: HourlyElectricityProductionAndConsumption) => x.production.filter(_.supplyChain == supplyChain).head.production
+      )
+    }.toList
+
+    getFieldsStatistics(
+      data.hourlyElectricityProductionAndConsumption,
+      productionBySupplyChainFields,
+      (_: HourlyElectricityProductionAndConsumption).dateTime.toLocalDate,
+      start,
+      end
+    )
+  }
+
+  /** Get global statistics on the temperature and power consumption.
+    *
+    * @param data
+    *   The data to analyse.
+    * @param start
+    *   The start date of the period.
+    * @param end
+    *   The end date of the period.
+    * @return
+    *   The global statistics on the period.
+    */
+  def getTemperatureAndConsumptionStatistics(
+      data: LoadedData,
+      start: LocalDate,
+      end: LocalDate
+  ): List[Statistics] = {
+
+    val tempratureAndPowerPeakFields = List(
+      FieldSelector("Daily mean temperature (C)", (_: DailyPowerPeakWithTemperature).meanTemperature),
+      FieldSelector("Daily peak of power (MW)", (_: DailyPowerPeakWithTemperature).powerPeak)
+    )
+
+    val consumptionFields = List(
+      FieldSelector("Power consumption (MW)", (_: HourlyElectricityProductionAndConsumption).consumption)
+    )
+
+    getFieldsStatistics(
+      data.dailyPowerPeakWithTemperature,
+      tempratureAndPowerPeakFields,
+      (_: DailyPowerPeakWithTemperature).date,
+      start,
+      end
+    ) ++ getFieldsStatistics(
+      data.hourlyElectricityProductionAndConsumption,
+      consumptionFields,
+      (_: HourlyElectricityProductionAndConsumption).dateTime.toLocalDate,
+      start,
+      end
+    )
+  }
+}