Merge branch 'dev' into pp/#1012-chpmodelspec-and-cylindricalthermals…

…toragespec-also-need-adaptions-for-storage-without-storagevolumelvlmin

.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+# © 2024. TU Dortmund University,
+# Institute of Energy Systems, Energy Efficiency and Energy Economics,
+# Research group Distribution grid planning and operation
+#
+
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+    branches:
+      - main
+      - dev
+      - 'hotfix/*'
+      - 'rel/*'
+      - 'dependabot/*'
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  buildAndTest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          ref: ${{ github.event.pull_request.head.ref || github.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build Project
+        run: ./gradlew --refresh-dependencies clean assemble spotlessCheck
+
+      - name: Run Tests
+        run: ./gradlew test reportScoverage checkScoverage
+
+      - name: Build Scala-Docs
+        run: ./gradlew scaladoc
+
+      - name: SonarQube
+        run: |
+          ./gradlew sonar \
+          -Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} \
+          -Dsonar.host.url=${{ vars.SONAR_HOST_URL }} \
+          -Dsonar.login=${{ secrets.SONAR_TOKEN }}
+
+          SONAR_STATUS_URL="${{ vars.SONAR_HOST_URL }}/api/qualitygates/project_status?projectKey=${{ vars.SONAR_PROJECT_KEY }}"
+          QUALITY_GATE_STATUS=$(curl -s -u "${{ secrets.SONAR_TOKEN }}:" "$SONAR_STATUS_URL" | jq -r '.projectStatus.status')
+            
+          echo "Quality Gate Status: $QUALITY_GATE_STATUS"
+          if [ "$QUALITY_GATE_STATUS" != "OK" ]; then
+            echo "Quality Gate failed!"
+            exit 1
+          fi
+
+      - name: Deploy
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+        run: |
+          ./gradlew publish\
+            -Puser=${{ secrets.MAVENCENTRAL_USER }} \
+            -Ppassword=${{ secrets.MAVENCENTRAL_PASS }} \
+            -Psigning.keyId=${{ secrets.MAVENCENTRAL_SIGNINGKEYID }} \
+            -Psigning.password=${{ secrets.MAVENCENTRAL_SIGNINGPASS }} \
+            -Psigning.secretKeyRingFile=${{ secrets.MAVENCENTRAL_SIGNINGKEY }}

CHANGELOG.md

@@ -36,6 +36,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added option to directly zip the output files [#793](https://github.com/ie3-institute/simona/issues/793)
 - Added weatherData HowTo for Copernicus ERA5 data [#967](https://github.com/ie3-institute/simona/issues/967)
 - Add some quote to 'printGoodbye' [#997](https://github.com/ie3-institute/simona/issues/997)
+- Add unapply method for ThermalHouseResults [#934](https://github.com/ie3-institute/simona/issues/934)
+- Added `ApparentPower` to differentiate between different power types [#794](https://github.com/ie3-institute/simona/issues/794)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)
@@ -75,6 +77,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated dependabot reviewers [#888](https://github.com/ie3-institute/simona/issues/888)
 - Merged `HpModelTestData` with `HpTestData` to `HpInputTestData` [#872](https://github.com/ie3-institute/simona/issues/872)
 - Harmonised both methods that check the inner temperature of thermal house against the boundaries [#880](https://github.com/ie3-institute/simona/issues/880)
+- Changed implementation of actor naming for unique name generation [#103](https://github.com/ie3-institute/simona/issues/103)
 - Convert all `eval-rst` instances in rtd to myst syntax [#901](https://github.com/ie3-institute/simona/issues/901)
 - External simulation should provide information about next tick of MobSim [#776](https://github.com/ie3-institute/simona/issues/776)
 - Reverted temporary workaround in `spotless.gradle` [#681](https://github.com/ie3-institute/simona/issues/681)
@@ -93,8 +96,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rewrote CylindricalThermalStorageTest Test from groovy to scala [#646](https://github.com/ie3-institute/simona/issues/646)
 - Replace mutable var in ChpModelSpec [#1002](https://github.com/ie3-institute/simona/issues/1002)
 - Move compression of output files into `ResultEventListener`[#965](https://github.com/ie3-institute/simona/issues/965)
+- Rewrote StorageModelTest from groovy to scala [#646](https://github.com/ie3-institute/simona/issues/646)
+- Updated `ExtEvSimulationClasses` [#898](https://github.com/ie3-institute/simona/issues/898)
+- Refactoring of `ThermalGrid.energyGrid` to distinguish between demand of house and storage [#928](https://github.com/ie3-institute/simona/issues/928)
+- Refactoring to use zeroKW and zeroKWH in thermal grid unit tests [#1023](https://github.com/ie3-institute/simona/issues/1023)
+- Refactor `ResultFileHierarchy` [#1031](https://github.com/ie3-institute/simona/issues/1031)
+- Removing logs in `logs/simona` [#1017](https://github.com/ie3-institute/simona/issues/1017)
 
 ### Fixed
+- Fix rendering of references in documentation [#505](https://github.com/ie3-institute/simona/issues/505)
 - Removed a repeated line in the documentation of vn_simona config [#658](https://github.com/ie3-institute/simona/issues/658)
 - Removed version number "2.0" from the logo printed to console [#642](https://github.com/ie3-institute/simona/issues/642)
 - Fixed PV Model documentation [#684](https://github.com/ie3-institute/simona/issues/684), [#686](https://github.com/ie3-institute/simona/issues/686)
@@ -126,6 +136,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix CheckWindow duration [#921](https://github.com/ie3-institute/simona/issues/921)
 - Fixed ThermalStorageResults having multiple entries [#924](https://github.com/ie3-institute/simona/issues/924)
 - Fix filter for thermal result checking for lastTick not for currentTick [#1008](https://github.com/ie3-institute/simona/issues/1008)
+- Fixed `CHANGELOG` entry for issue ([#103](https://github.com/ie3-institute/simona/issues/103)) [#941](https://github.com/ie3-institute/simona/issues/941)
+- Fix grammar and spelling in docs and comments [#1022](https://github.com/ie3-institute/simona/issues/1022)
+- Fix some minor issues and findings from inspections [#1019](https://github.com/ie3-institute/simona/issues/1019)
+- Fix initialisation freezing on empty primary data [#981](https://github.com/ie3-institute/simona/issues/981)
 
 ## [3.0.0] - 2023-08-07
 
@@ -188,7 +202,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changed format of example grid `vn_simona` [#216](https://github.com/ie3-institute/simona/issues/216)
 - Renamed ChpData to ChpRelevantData [#494](https://github.com/ie3-institute/simona/issues/494)
 - Updated gradle to 8.2.1, cleaned up `build.gradle` and `Jenkinsfile` [#572](https://github.com/ie3-institute/simona/issues/572)
-- Changed implementation of actor naming for unique name generation [#103](https://github.com/ie3-institute/simona/issues/103)
 
 ### Fixed
 - Location of `vn_simona` test grid (was partially in Berlin and Dortmund) [#72](https://github.com/ie3-institute/simona/issues/72)
@@ -219,12 +232,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for three winding transformers  [#63](https://github.com/ie3-institute/simona/issues/63)
   - Handle incoming slack voltage accordingly
   - Allow multiple sub grid gates at one node (also allows multiple two winding transformers at one node)
-  - Perform power flow calculation in highest grid, if a three winding transformer is apparent
+  - Perform power flow calculation in the highest grid, if a three winding transformer is apparent
   - Write out results
 - Fixed broken layout in RTD documentation [#500](https://github.com/ie3-institute/simona/issues/500)
 - Corrected tests in RefSystemTest [#560](https://github.com/ie3-institute/simona/issues/560)
 - Take log file event filters from `logback.xml` when defining the run log appender [#108](https://github.com/ie3-institute/simona/issues/108)
-- Fix rendering of references in documentation [#505](https://github.com/ie3-institute/simona/issues/505)
 
 ### Removed
 - Remove workaround for tscfg tmp directory [#178](https://github.com/ie3-institute/simona/issues/178)

Jenkinsfile

@@ -111,7 +111,7 @@ node {
 
         sh 'java -version'
 
-        gradle('--refresh-dependencies spotlessCheck pmdMain pmdTest', projectName)
+        gradle('--refresh-dependencies spotlessCheck test', projectName)
 
         sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew javadoc''', returnStdout: true)
       }
@@ -421,9 +421,6 @@ def publishReports(String relativeProjectDir) {
   // publish test reports
   publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/tests/allTests', reportFiles: 'index.html', reportName: "${relativeProjectDir}_java_tests_report", reportTitles: ''])
 
-  // publish pmd report for main project only
-  publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/pmd', reportFiles: 'main.html', reportName: "${relativeProjectDir}_pmd_report", reportTitles: ''])
-
   // publish scalatest reports for main project only (currently the only one with scala sources!)
   publishHTML([allowMissing: false, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/tests/scalatest', reportFiles: 'index.html', reportName: "${relativeProjectDir}_scala_tests_report", reportTitles: ''])
 

build.gradle

@@ -6,13 +6,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 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '6.25.0'// code format
   id "com.github.ben-manes.versions" version '0.51.0'
   id "de.undercouch.download" version "5.6.0" // downloads plugin
   id "kr.motd.sphinx" version "2.10.1" // documentation generation
   id "com.github.johnrengelman.shadow" version "8.1.1" // fat jar
-  id "org.sonarqube" version "5.1.0.4882" // sonarqube
+  id "org.sonarqube" version "6.0.0.5145" // sonarqube
   id "org.scoverage" version "8.1" // scala code coverage scoverage
   id "com.github.maiflai.scalatest" version "0.32" // run scalatest without specific spec task
   id 'org.hidetake.ssh' version '2.11.2'
@@ -45,7 +44,6 @@ java {
   targetCompatibility = javaVersion
 }
 
-apply from: scriptsLocation + 'pmd.gradle'
 apply from: scriptsLocation + 'spotless.gradle'
 apply from: scriptsLocation + 'checkJavaVersion.gradle'
 apply from: scriptsLocation + 'tscfg.gradle' // config tasks
@@ -147,7 +145,7 @@ dependencies {
   implementation 'org.apache.commons:commons-math3:3.6.1' // apache commons math3
   implementation 'org.apache.poi:poi-ooxml:5.3.0' // used for FilenameUtils
   implementation 'javax.measure:unit-api:2.2'
-  implementation 'tech.units:indriya:2.2' // quantities
+  implementation 'tech.units:indriya:2.2.1' // quantities
   implementation "org.typelevel:squants_${scalaVersion}:1.8.3"
   implementation 'org.apache.commons:commons-csv:1.12.0'
   implementation 'org.scalanlp:breeze_2.13:2.1.0' // scientific calculations (http://www.scalanlp.org/)

docs/readthedocs/developersguide.md

@@ -2,7 +2,7 @@
 
 # Developer’s Guide
 
-The SIMONA repository can be found [on Github](https://github.com/ie3-institute/simona).
+The SIMONA repository can be found [on GitHub](https://github.com/ie3-institute/simona).
 
 ```{contents}
 ---

docs/readthedocs/models/chp_model.md

@@ -6,7 +6,7 @@ This page documents the functionality of the CHP Model (combined heat and power
 
 ## Assumptions
 
-The CHP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the CHP unit does not posses a memory. Losses of the heat storage are not considered.
+The CHP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the CHP unit does not possess a memory. Losses of the heat storage are not considered.
 
 ## Parameters
 

docs/readthedocs/models/cts_model.md

@@ -3,7 +3,7 @@
 This page documents the functionality of the cylindrical thermal storage available in SIMONA.
 
 ## Behaviour
-This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore it is assumed that the storage medium is water. Also the model holds a variable for the current storage level.
+This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore, it is assumed that the storage medium is water. Also, the model holds a variable for the current storage level.
 
 ## Attributes, Units and Remarks
 

docs/readthedocs/models/em.md

@@ -16,7 +16,7 @@ If an EmAgent is itself controlled by another EmAgent, it also behaves like a sy
 Every EmAgent aggregates flex options and power of its connected assets and disaggregates flex control among the connected assets. 
 It also functions as a scheduler for all connected assets by processing information on the ticks of the next desired activations and conveying such information to the controlling EmAgent or a central scheduler respectively.
 
-Uncontrolled EmAgents answer to a scheduler with regards to their activation.
+Uncontrolled EmAgents answer to a scheduler with regard to their activation.
 
 ![](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/ie3-institute/simona/dev/docs/uml/protocol/em/UncontrolledEm.puml)
 

docs/readthedocs/models/hp_model.md

@@ -6,7 +6,7 @@ This page documents the functionality of the Heat Pump Model (HP model) availabl
 
 ## Assumptions
 
-The HP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the HP unit does not posses a memory. 
+The HP unit is able to operate either at full load or not at all. Uncovered heat demand of former time-steps is not considered in the following steps, as the HP unit does not possess a memory. 
 
 ## Parameters
 
@@ -17,6 +17,6 @@ Please refer to {doc}`PowerSystemDataModel - HP Model <psdm:models/input/partici
 ## Implemented Behaviour
 
 - Agent Objectives
-  The objective of the HP agent is to cover the given heat demand of it's thermal bus in each time-step.
+  The objective of the HP agent is to cover the given heat demand of its thermal bus in each time-step.
 
 The implemented behaviour is shown in the program sequence plan below. In general, the unit will turn on, if the thermal bus is demanding heat. During operation, the HP unit operates at full utilization.

docs/readthedocs/models/load_model.md

@@ -132,7 +132,7 @@ F_t = -3.92 \cdot 10^{-10} \cdot t^4 + 3.2 \cdot 10^{-7}
 \cdot t + 1.24
 $$
 
-The factor $F_t$, after calculation, shall be rounded to four decimal places. After multiplication with the profile value for given quarter hour, the result should again be rounded to one decimal place.
+The factor $F_t$, after calculation, shall be rounded to four decimal places. After multiplication with the profile value for given quarter-hour, the result should again be rounded to one decimal place.
 
 #### Maximum value
 

docs/readthedocs/models/thermal_house_model.md

@@ -6,7 +6,7 @@ This page documents the functionality of the thermal house available in SIMONA.
 
 ## Behaviour
 
-This house model represents the thermal behaviour of a building. This reflects a simple shoe box with a thermal capacity and with transmission losses.
+This house model represents the thermal behaviour of a building. This reflects a simple shoebox with a thermal capacity and with transmission losses.
 
 ## Attributes, Units and Remarks
 

docs/readthedocs/models/two_winding_transformer_model.md

@@ -32,7 +32,7 @@ When the load flow calculation asks for the values with regard to the low voltag
 3. Main field resistance: $R_{M,LV} = \frac{R_{M}}{\gamma^{2}}$
 4. Main field reactance: $X_{M,LV} = \frac{X_{M}}{\gamma^{2}}$
 
-Finally all values are delivered as per unit-values and ready to use in the fundamental $\pi$circuit:
+Finally, all values are delivered as per unit-values and ready to use in the fundamental $\pi$circuit:
 
 1. Short circuit conductance: $g_{ij} = \frac{Z_{Ref}}{R_{SC}}$
 2. Short circuit susceptance: $b_{ij} = \frac{Z_{Ref}}{X_{SC}}$

docs/readthedocs/requirements.txt

@@ -1,7 +1,7 @@
 Sphinx==8.1.3
-sphinx-rtd-theme==3.0.1
+sphinx-rtd-theme==3.0.2
 sphinxcontrib-plantuml==0.30
 myst-parser==4.0.0
 markdown-it-py==3.0.0
-sphinx-hoverxref==1.4.1
+sphinx-hoverxref==1.4.2
 sphinxcontrib-bibtex==2.6.3

docs/readthedocs/usersguide.md

@@ -37,7 +37,7 @@ You can either delegate the job to your preferred IDE or build an executable jar
 In order to be able to execute SIMONA from a CLI, you need an executable fat jar. A fat jar contains all compiled classes and dependencies, ready for execution. For building one, you can use a Gradle task of the project.
 
 1. Open a CLI and change directories to the top level directory of the project.   
-2. Execute ``gradlew shadowJar`` within the CLI. This creates a fat jar of SIMONA inside of the directory ``build/libs``.   
+2. Execute ``gradlew shadowJar`` within the CLI. This creates a fat jar of SIMONA inside the directory ``build/libs``.   
 3. For executing a fat jar you need to specify the classpath of the entrypoint of your application. Assuming we are still in the top level directory of our project, the execution command would look as follows: