Merge branch 'dev' into ms/#53-upgrate-to-scala3

# Conflicts:
#	.scalafmt.conf
#	CHANGELOG.md
#	src/main/scala/edu/ie3/simona/config/SimonaConfig.scala
#	src/main/scala/edu/ie3/simona/main/RunSimonaStandalone.scala
#	src/main/scala/edu/ie3/simona/model/em/PrioritizedFlexStrat.scala
#	src/main/scala/edu/ie3/simona/model/participant2/ParticipantModelInit.scala
#	src/main/scala/edu/ie3/simona/model/participant2/ParticipantModelShell.scala
#	src/main/scala/edu/ie3/simona/ontology/messages/flex/MinMaxFlexibilityMessage.scala
#	src/main/scala/edu/ie3/simona/sim/setup/SetupHelper.scala
#	src/main/scala/edu/ie3/simona/util/ResultFileHierarchy.scala
#	src/test/scala/edu/ie3/simona/agent/grid/ThermalGridIT.scala
#	src/test/scala/edu/ie3/simona/integration/RunSimonaStandaloneIT.scala

Author: staudtMarius

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.7.3
+version = 3.8.1
 runner.dialect = scala3
 
 rewrite.scala3.convertToNewSyntax = false

CHANGELOG.md

@@ -64,6 +64,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Integration test for thermal grids without Em [#1145](https://github.com/ie3-institute/simona/issues/1145)
 - Change thermal house behaviour to heat till targetTemperature [#1176](https://github.com/ie3-institute/simona/issues/1176)
 - Add test case to EmAgentIT to check for correct reactive power [#1185](https://github.com/ie3-institute/simona/issues/1185)
+- Integration test for thermal grids with Em [#1146](https://github.com/ie3-institute/simona/issues/1146)
+- Added check for equal start and end date of simulation to ConfigFailFast [#1317](https://github.com/ie3-institute/simona/issues/1317)
+- Introduce ParticipantModel factory pattern [#1324](https://github.com/ie3-institute/simona/issues/1324)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)
@@ -165,6 +168,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Converting `WeatherService` to pekko typed [#1216](https://github.com/ie3-institute/simona/issues/1216)
 - Converting `PrimaryServiceWorker` to pekko typed [#1229](https://github.com/ie3-institute/simona/issues/1229)
 - Converting `PrimaryServiceProxy` to pekko typed [#1230](https://github.com/ie3-institute/simona/issues/1230)
+- Made some methods of `PvModel` static [#1217](https://github.com/ie3-institute/simona/issues/1217)
+- FlexOptions types in `FlexibilityMessage` [#1306](https://github.com/ie3-institute/simona/issues/1306)
+- Isolate solar radiation calculations of PvModel to its own object [#1327](https://github.com/ie3-institute/simona/issues/1327)
 - Upgraded `scala2` to `scala3` [#53](https://github.com/ie3-institute/simona/issues/53)
 
 ### Fixed
@@ -228,6 +234,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix vn_simona time series mapping [#1288](https://github.com/ie3-institute/simona/issues/1288)
 - Fix hierarchical em structures leading to exception while initializing [#1293](https://github.com/ie3-institute/simona/issues/1293)
 - Fix failing `ExtEvDataServiceSpec` [#1297](https://github.com/ie3-institute/simona/issues/1297)
+- Fixed pekko config not written as output [#1302](https://github.com/ie3-institute/simona/issues/1302)
+- Cleanups and log capturing in `ExtEvDataServiceSpec` [#1320](https://github.com/ie3-institute/simona/issues/1320)
 
 ### Removed
 - Removed `SimonaListerner` and related code [#1205](https://github.com/ie3-institute/simona/issues/1205)

build.gradle

@@ -5,12 +5,12 @@ plugins {
   id 'scala' // scala support
   id 'signing'
   id 'maven-publish' // publish to a maven repo (local or mvn central, has to be defined)
-  id 'com.diffplug.spotless' version '6.25.0' // code format
+  id 'com.diffplug.spotless' version '7.0.2' // code format
   id "com.github.ben-manes.versions" version '0.52.0'
   id "de.undercouch.download" version "5.6.0" // downloads plugin
   id "kr.motd.sphinx" version "2.10.1" // documentation generation
   id 'com.gradleup.shadow' version '8.3.6' // fat jar
-  id "org.sonarqube" version "6.0.1.5171" // sonarqube
+  id "org.sonarqube" version "6.1.0.5360" // sonarqube
   id "org.scoverage" version "8.1" // scala code coverage scoverage
   id 'org.hidetake.ssh' version '2.11.2'
   id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
@@ -210,8 +210,7 @@ tasks.withType(ScalaCompile).configureEach {
   scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
     "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/src/",
-    "-P:scapegoat:disabledInspections:VariableShadowing",
-    "-P:scapegoat:ignoredFiles:.*/SimonaConfig.scala" // see scapegoat-sbt page for this param
+    "-P:scapegoat:disabledInspections:TryGet"
   ]
   scalaCompileOptions.forkOptions.jvmArgs = [
     '-Xss2m',
@@ -224,7 +223,7 @@ compileTestScala {
   scalaCompileOptions.additionalParameters = scala3compilerOptions + [
     "-Xplugin:" + configurations.scalaCompilerPlugin.asPath,
     "-P:scapegoat:dataDir:" + project.layout.buildDirectory.get().asFile.absolutePath + "/reports/scapegoat/testsrc/",
-    "-P:scapegoat:disabledInspections:VariableShadowing"
+    "-P:scapegoat:disabledInspections:TryGet"
   ]
 }
 

docs/readthedocs/models/thermal_house_model.md

@@ -4,6 +4,7 @@
 
 This page documents the functionality of the thermal house available in SIMONA.
 
+
 ## Behaviour
 
 This house model represents the thermal behaviour of a building. It represents a simple shoebox with thermal capacity and transmission losses.
@@ -21,7 +22,9 @@ As the storage is initialised as empty, the heat source will start charging the
 
 ### Behaviour under EM control
 
-Currently, not fully supported. Will be fixed by [PR #1159](https://github.com/ie3-institute/simona/pull/1159)
+When {ref}`em` is applied to the heat source of this building, the thermal behaviour should be basically the same as without EM control, so internal temperature of the house should remain between the target temperature and the lower temperature limit. 
+
+However, for flexibility usage, the energy management system can turn on the heat source whenever the thermal house has additional demand. Same for the thermal storage. When the heat source is EM controlled, the thermal storage will only be recharged when the flexibility strategy allows. E.g. when there is surplus energy from PV plant.
 
 ## Attributes, Units and Remarks
 

gradle/scripts/spotless.gradle

@@ -19,7 +19,7 @@ spotless {
     // same as groovy, but for .gradle (defaults to '*.gradle')
     target('*.gradle', 'gradle/scripts/*.gradle')
     greclipse()
-    indentWithSpaces(2)
+    leadingTabsToSpaces(2)
   }
 
   //sets a license header, removes unused imports and formats conforming to the scala fmt formatter
@@ -32,15 +32,15 @@ spotless {
   format ('misc') {
     target('**/.gitignore', 'configs/**')
     trimTrailingWhitespace()
-    indentWithTabs()
+    leadingSpacesToTabs()
     endWithNewline()
   }
 
   /* Formats markdown files, just like the other misc files, but without trimming trailing white spaces (nested
    * enumerations) */
   format('md') {
     target('**/*.md')
-    indentWithSpaces(2)
+    leadingTabsToSpaces(2)
     endWithNewline()
   }
 }

src/main/scala/edu/ie3/simona/agent/em/EmAgent.scala

@@ -24,7 +24,7 @@ import edu.ie3.simona.ontology.messages.SchedulerMessage.{
   ScheduleActivation,
 }
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage._
-import edu.ie3.simona.ontology.messages.flex.MinMaxFlexibilityMessage.ProvideMinMaxFlexOptions
+import edu.ie3.simona.ontology.messages.flex.MinMaxFlexOptions
 import edu.ie3.simona.ontology.messages.{Activation, SchedulerMessage}
 import edu.ie3.simona.util.TickUtil.TickLong
 import edu.ie3.util.quantities.QuantityUtils.RichQuantityDouble
@@ -33,6 +33,7 @@ import org.apache.pekko.actor.typed.scaladsl.Behaviors
 import org.apache.pekko.actor.typed.{ActorRef, Behavior}
 
 import java.time.ZonedDateTime
+import scala.util.{Failure, Try}
 
 /** Energy management agent that receives flex options from and issues control
   * messages to connected agents
@@ -223,14 +224,17 @@ object EmAgent {
       modelShell: EmModelShell,
       flexOptionsCore: EmDataCore.AwaitingFlexOptions,
   ): Behavior[Request] = Behaviors.receiveMessagePartial {
-    case flexOptions: ProvideFlexOptions =>
-      val updatedCore = flexOptionsCore.handleFlexOptions(flexOptions)
+    case provideFlex: ProvideFlexOptions =>
+      val updatedCore = flexOptionsCore.handleFlexOptions(
+        provideFlex.modelUuid,
+        provideFlex.flexOptions,
+      )
 
       if (updatedCore.isComplete) {
 
         val allFlexOptions = updatedCore.getFlexOptions
 
-        val (emRef, emMin, emMax) =
+        val emFlexOptions =
           modelShell.aggregateFlexOptions(allFlexOptions)
 
         if (emData.outputConfig.flexResult) {
@@ -239,9 +243,9 @@ object EmAgent {
               emData.simulationStartDate
             ),
             modelShell.uuid,
-            emRef.toMegawatts.asMegaWatt,
-            emMin.toMegawatts.asMegaWatt,
-            emMax.toMegawatts.asMegaWatt,
+            emFlexOptions.ref.toMegawatts.asMegaWatt,
+            emFlexOptions.min.toMegawatts.asMegaWatt,
+            emFlexOptions.max.toMegawatts.asMegaWatt,
           )
 
           emData.listener.foreach {
@@ -252,19 +256,15 @@ object EmAgent {
         emData.parentData match {
           case Right(flexStateData) =>
             // provide aggregate flex options to parent
-            val flexMessage = ProvideMinMaxFlexOptions(
+            flexStateData.emAgent ! ProvideFlexOptions(
               modelShell.uuid,
-              emRef,
-              emMin,
-              emMax,
+              emFlexOptions,
             )
 
-            flexStateData.emAgent ! flexMessage
-
             val updatedEmData = emData.copy(
               parentData = Right(
                 flexStateData.copy(
-                  lastFlexOptions = Some(flexMessage)
+                  lastFlexOptions = Some(emFlexOptions)
                 )
               )
             )
@@ -327,10 +327,17 @@ object EmAgent {
         )
       )
 
-      val setPointActivePower = EmTools.determineFlexPower(
-        ownFlexOptions,
-        flexCtrl,
-      )
+      val setPointActivePower =
+        Try(EmTools.determineFlexPower(ownFlexOptions, flexCtrl))
+          .recoverWith(exception =>
+            Failure(
+              new CriticalFailureException(
+                s"Determining flex power failed for EmAgent ${modelShell.uuid}",
+                exception,
+              )
+            )
+          )
+          .get
 
       // flex options calculated by connected agents
       val receivedFlexOptions = flexOptionsCore.getFlexOptions

src/main/scala/edu/ie3/simona/agent/em/EmDataCore.scala

@@ -10,6 +10,7 @@ import edu.ie3.simona.agent.em.EmAgent.Actor
 import edu.ie3.simona.agent.em.FlexCorrespondenceStore.WithTime
 import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ComplexPower
 import edu.ie3.simona.exceptions.CriticalFailureException
+import edu.ie3.simona.ontology.messages.flex.FlexOptions
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage._
 import edu.ie3.simona.util.SimonaConstants.INIT_SIM_TICK
 import edu.ie3.util.scala.collection.mutable.PriorityMultiBiSet
@@ -251,13 +252,13 @@ object EmDataCore {
       *   The updated [[AwaitingFlexOptions]] core
       */
     def handleFlexOptions(
-        flexOptions: ProvideFlexOptions
+        modelUuid: UUID,
+        flexOptions: FlexOptions,
     ): AwaitingFlexOptions =
       copy(
         correspondences =
-          correspondences.updateFlexOptions(flexOptions, activeTick),
-        awaitedConnectedAgents =
-          awaitedConnectedAgents.excl(flexOptions.modelUuid),
+          correspondences.updateFlexOptions(modelUuid, flexOptions, activeTick),
+        awaitedConnectedAgents = awaitedConnectedAgents.excl(modelUuid),
       )
 
     /** Checks whether all awaited flex options have been received, and we can
@@ -273,7 +274,7 @@ object EmDataCore {
       * @return
       *   all relevant flex options
       */
-    def getFlexOptions: Iterable[(UUID, ProvideFlexOptions)] =
+    def getFlexOptions: Iterable[(UUID, FlexOptions)] =
       correspondences.store.flatMap { case (model, correspondence) =>
         correspondence.receivedFlexOptions.map(model -> _.get)
       }

src/main/scala/edu/ie3/simona/agent/em/FlexCorrespondenceStore.scala

@@ -11,10 +11,8 @@ import edu.ie3.simona.agent.em.FlexCorrespondenceStore.{
   WithTime,
 }
 import edu.ie3.simona.agent.participant.data.Data.PrimaryData.ComplexPower
-import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage.{
-  IssueFlexControl,
-  ProvideFlexOptions,
-}
+import edu.ie3.simona.ontology.messages.flex.FlexOptions
+import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage.IssueFlexControl
 
 import java.time.ZonedDateTime
 import java.util.UUID
@@ -36,6 +34,8 @@ final case class FlexCorrespondenceStore(
   /** Updates the latest flex options for the flex provider, overwriting the
     * former flex options, if applicable
     *
+    * @param modelUuid
+    *   The UUID of the flex provider model
     * @param flexOptions
     *   The new flex options
     * @param tick
@@ -44,11 +44,12 @@ final case class FlexCorrespondenceStore(
     *   The updated flex options store
     */
   def updateFlexOptions(
-      flexOptions: ProvideFlexOptions,
+      modelUuid: UUID,
+      flexOptions: FlexOptions,
       tick: Long,
   ): FlexCorrespondenceStore =
     updateCorrespondence(
-      flexOptions.modelUuid,
+      modelUuid,
       _.copy(receivedFlexOptions = Some(WithTime(flexOptions, tick))),
     )
 
@@ -122,7 +123,7 @@ object FlexCorrespondenceStore {
     *   The latest result that has been received by the EmAgent
     */
   final case class FlexCorrespondence(
-      receivedFlexOptions: Option[WithTime[ProvideFlexOptions]] = None,
+      receivedFlexOptions: Option[WithTime[FlexOptions]] = None,
       issuedCtrlMsg: Option[WithTime[IssueFlexControl]] = None,
       receivedResult: Option[WithTime[ComplexPower]] = None,
   )

src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala

@@ -81,7 +81,7 @@ import edu.ie3.simona.model.participant.{
 import edu.ie3.simona.ontology.messages.Activation
 import edu.ie3.simona.ontology.messages.SchedulerMessage.Completion
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage._
-import edu.ie3.simona.ontology.messages.flex.MinMaxFlexibilityMessage.ProvideMinMaxFlexOptions
+import edu.ie3.simona.ontology.messages.flex.MinMaxFlexOptions
 import edu.ie3.simona.util.TickUtil._
 import edu.ie3.util.quantities.PowerSystemUnits._
 import edu.ie3.util.quantities.QuantityUtils.RichQuantityDouble
@@ -676,7 +676,10 @@ protected trait ParticipantAgentFundamentals[
         )
       )
 
-    updatedFlexData.emAgent ! newestFlexOptions
+    updatedFlexData.emAgent ! ProvideFlexOptions(
+      participantStateData.modelUuid,
+      newestFlexOptions,
+    )
 
     updatedBaseStateData
   }
@@ -703,15 +706,14 @@ protected trait ParticipantAgentFundamentals[
     // does not include reactive power which could change later)
     if (baseStateData.outputConfig.flexResult) {
       val flexResult = flexOptions match {
-        case ProvideMinMaxFlexOptions(
-              modelUuid,
+        case MinMaxFlexOptions(
               referencePower,
               minPower,
               maxPower,
             ) =>
           new FlexOptionsResult(
             tick.toDateTime,
-            modelUuid,
+            baseStateData.modelUuid,
             referencePower.toMegawatts.asMegaWatt,
             minPower.toMegawatts.asMegaWatt,
             maxPower.toMegawatts.asMegaWatt,
@@ -753,7 +755,16 @@ protected trait ParticipantAgentFundamentals[
       )
 
     val setPointActivePower =
-      EmTools.determineFlexPower(flexOptions, flexCtrl)
+      Try(EmTools.determineFlexPower(flexOptions, flexCtrl))
+        .recoverWith(exception =>
+          Failure(
+            new CriticalFailureException(
+              s"Determining flex power failed for model ${baseStateData.modelUuid}",
+              exception,
+            )
+          )
+        )
+        .get
 
     /* Handle the flex signal */
     val (updatedState, result, flexChangeIndicator) =

src/main/scala/edu/ie3/simona/agent/participant/statedata/BaseStateData.scala

@@ -16,10 +16,10 @@ import edu.ie3.simona.model.participant.{
   ModelState,
   SystemParticipant,
 }
+import edu.ie3.simona.ontology.messages.flex.FlexOptions
 import edu.ie3.simona.ontology.messages.flex.FlexibilityMessage.{
   FlexRequest,
   FlexResponse,
-  ProvideFlexOptions,
 }
 import org.apache.pekko.actor.typed.ActorRef
 import org.apache.pekko.actor.{ActorRef => ClassicActorRef}
@@ -250,7 +250,7 @@ object BaseStateData {
   final case class FlexControlledData(
       emAgent: ActorRef[FlexResponse],
       flexAdapter: ActorRef[FlexRequest],
-      lastFlexOptions: Option[ProvideFlexOptions] = None,
+      lastFlexOptions: Option[FlexOptions] = None,
   )
 
   /** Updates the base state data with the given value stores

src/main/scala/edu/ie3/simona/agent/participant2/ParticipantAgent.scala

@@ -455,7 +455,10 @@ object ParticipantAgent {
                   throw new CriticalFailureException(
                     "Received flex activation while not controlled by EM"
                   ),
-                _.emAgent ! shellWithFlex.flexOptions,
+                _.emAgent ! ProvideFlexOptions(
+                  shellWithFlex.uuid,
+                  shellWithFlex.getFlexOptions,
+                ),
               )
 
               (shellWithFlex, gridAdapter)