Merge branch 'dev' into ms/#1106-transfer-LoadProfile-parsing-code-from-SIMONA

# Conflicts:
#	CHANGELOG.md
#	src/main/java/edu/ie3/datamodel/io/factory/timeseries/RandomLoadProfileFactory.java
#	src/main/java/edu/ie3/datamodel/models/timeseries/repetitive/RandomLoadProfileTimeSeries.java

Author: staudtMarius

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Extend ValidationUtils for validating ThermalGrids [#1216](https://github.com/ie3-institute/PowerSystemDataModel/issues/1216) 
 - Enhance `TimeSeriesSource` with method to retrieve the previous value before a given key [#1182](https://github.com/ie3-institute/PowerSystemDataModel/issues/1182)
 - Added `BdewLoadProfileTimeSeries` [#1230](https://github.com/ie3-institute/PowerSystemDataModel/issues/1230)
+- Added `RandomLoadProfileTimeSeries` [#1232](https://github.com/ie3-institute/PowerSystemDataModel/issues/1232)
 - Added load profiles sources [#1106](https://github.com/ie3-institute/PowerSystemDataModel/issues/1106)
 
 ### Fixed

build.gradle

@@ -5,7 +5,7 @@ plugins {
   id 'signing'
   id 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '7.0.2' //code format
-  id 'com.github.spotbugs' version '6.1.4' // code check, working on byte code
+  id 'com.github.spotbugs' version '6.1.5' // code check, working on byte code
   id 'de.undercouch.download' version '5.6.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
@@ -77,7 +77,7 @@ dependencies {
   testImplementation 'org.junit.jupiter:junit-jupiter:5.11.4'
   testImplementation "org.spockframework:spock-core:2.3-groovy-$groovyVersion"
   testImplementation 'org.objenesis:objenesis:3.4' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.17.0' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.17.1' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"

docs/readthedocs/requirements.txt

@@ -2,5 +2,5 @@ commonmark==0.9.1
 recommonmark==0.7.1
 Sphinx==8.1.3
 sphinx-rtd-theme==3.0.2
-myst-parser==4.0.0
+myst-parser==4.0.1
 markdown-it-py==3.0.0

src/main/java/edu/ie3/datamodel/io/factory/timeseries/RandomLoadProfileFactory.java

@@ -88,12 +88,28 @@ public RandomLoadProfile parseProfile(String profile) {
     return RANDOM_LOAD_PROFILE;
   }
 
+  /**
+   * This is the 95 % quantile resulting from 10,000 evaluations of the year 2019. It is only
+   * needed, when the load is meant to be scaled to rated active power.
+   *
+   * @return Reference active power to use for later model calculations
+   */
   @Override
   public ComparableQuantity<Power> calculateMaxPower(
       RandomLoadProfile loadProfile, Set<LoadProfileEntry<RandomLoadValues>> loadProfileEntries) {
     return Quantities.getQuantity(159d, WATT);
   }
 
+  /**
+   * Returns the profile energy scaling factor, the random profile is scaled to.
+   *
+   * <p>It is said in 'Kays - Agent-based simulation environment for improving the planning of
+   * distribution grids', that the Generalized Extreme Value distribution's parameters are sampled
+   * from input data, that is normalized to 1,000 kWh annual energy consumption. However, due to
+   * inaccuracies in random data reproduction, the sampled values will lead to an average annual
+   * energy consumption of approx. this value. It has been found by 1,000 evaluations of the year
+   * 2019.
+   */
   @Override
   public ComparableQuantity<Energy> getLoadProfileEnergyScaling(RandomLoadProfile loadProfile) {
     return Quantities.getQuantity(716.5416966513656, PowerSystemUnits.KILOWATTHOUR);

src/main/java/edu/ie3/datamodel/models/timeseries/repetitive/LoadProfileTimeSeries.java

@@ -25,13 +25,13 @@ public class LoadProfileTimeSeries<V extends LoadValues>
   private final Map<Integer, V> valueMapping;
 
   /**
-   * The maximum average power consumption per quarter-hour for a given calculated over all seasons
-   * and weekday types of given load profile.
+   * The maximum average power consumption per quarter-hour calculated over all seasons and weekday
+   * types of given load profile.
    */
-  public final ComparableQuantity<Power> maxPower;
+  private final ComparableQuantity<Power> maxPower;
 
   /** The profile energy scaling in kWh. */
-  public final ComparableQuantity<Energy> profileEnergyScaling;
+  private final ComparableQuantity<Energy> profileEnergyScaling;
 
   public LoadProfileTimeSeries(
       UUID uuid,
@@ -50,6 +50,19 @@ public LoadProfileTimeSeries(
     this.profileEnergyScaling = profileEnergyScaling;
   }
 
+  /**
+   * Returns the maximum average power consumption per quarter-hour calculated over all seasons and
+   * weekday types of given load profile in Watt.
+   */
+  public Optional<ComparableQuantity<Power>> maxPower() {
+    return Optional.ofNullable(maxPower);
+  }
+
+  /** Returns the profile energy scaling in kWh. */
+  public Optional<ComparableQuantity<Energy>> loadProfileScaling() {
+    return Optional.ofNullable(profileEnergyScaling);
+  }
+
   /** Returns the {@link LoadProfile}. */
   public LoadProfile getLoadProfile() {
     return loadProfile;

src/main/java/edu/ie3/datamodel/models/timeseries/repetitive/RandomLoadProfileTimeSeries.java

@@ -8,7 +8,6 @@
 import de.lmu.ifi.dbs.elki.math.statistics.distribution.GeneralizedExtremeValueDistribution;
 import edu.ie3.datamodel.models.profile.LoadProfile;
 import edu.ie3.datamodel.models.value.load.RandomLoadValues;
-import java.util.Objects;
 import java.util.Set;
 import java.util.UUID;
 import javax.measure.quantity.Energy;
@@ -35,27 +34,8 @@ public LoadProfile.RandomLoadProfile getLoadProfile() {
     return (LoadProfile.RandomLoadProfile) super.getLoadProfile();
   }
 
-  @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (o == null || getClass() != o.getClass()) return false;
-    return super.equals(o);
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(super.hashCode());
-  }
-
   @Override
   public String toString() {
-    return "RandomLoadProfileTimeSeries{"
-        + "uuid="
-        + getUuid()
-        + "loadProfile="
-        + getLoadProfile()
-        + ", valueMapping="
-        + getValueMapping()
-        + '}';
+    return "Random" + super.toString();
   }
 }