Merge branch 'dev' into df/#1131-psdm-update-for-tap-water-demand

Author: danielfeismann

.github/dependabot.yml

@@ -9,7 +9,7 @@ updates:
   target-branch: dev
   reviewers:
   - t-ober
-  - sensarmad
+  - staudtMarius
   - sebastian-peter
   - danielfeismann
   - jo-bao

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Enhance `TimeSeriesSource` with method to retrieve all time keys after a given key [#543](https://github.com/ie3-institute/PowerSystemDataModel/issues/543)
 - Enhance `WeatherSource` with method to retrieve all time keys after a given key [#572](https://github.com/ie3-institute/PowerSystemDataModel/issues/572)
+- Adding timeseries for voltage values [#1128](https://github.com/ie3-institute/PowerSystemDataModel/issues/1128)
+- Added Staudt to list of reviewers [#1190](https://github.com/ie3-institute/PowerSystemDataModel/issues/1190)
 
 ### Fixed
 
@@ -18,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improving usage of streams on sql fetches [#827](https://github.com/ie3-institute/PowerSystemDataModel/issues/827)
 - Improving error message when using the outdated csv format [#1112](https://github.com/ie3-institute/PowerSystemDataModel/issues/1112)
 - Changed ThermalUnitValidation: Ensure that thermal boundaries of thermal house are not the same [#1186](https://github.com/ie3-institute/PowerSystemDataModel/issues/1186)
+- Converted `MappingEntry` into a normal class [#1087](https://github.com/ie3-institute/PowerSystemDataModel/issues/1087)
+- Renamed timeseries mapping `participant` column to `asset` [#1191](https://github.com/ie3-institute/PowerSystemDataModel/issues/1191)
 
 ## [5.1.0] - 2024-06-24
 

build.gradle

@@ -5,11 +5,11 @@ plugins {
   id 'signing'
   id 'pmd' // code check, working on source code
   id 'com.diffplug.spotless' version '6.25.0' //code format
-  id 'com.github.spotbugs' version '6.0.26' // code check, working on byte code
+  id 'com.github.spotbugs' version '6.0.27' // 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
-  id "org.sonarqube" version "6.0.0.5145" // sonarqube
+  id "org.sonarqube" version "6.0.1.5171" // sonarqube
   id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
 }
 
@@ -70,10 +70,10 @@ dependencies {
   // testing
   testImplementation "org.apache.groovy:groovy:$groovyBinaryVersion"
 
-  testImplementation 'org.junit.jupiter:junit-jupiter:5.11.3'
+  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.15.10' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.15.11' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -83,14 +83,14 @@ dependencies {
   testImplementation "org.testcontainers:couchbase:$testcontainersVersion"
 
   // logging
-  implementation platform('org.apache.logging.log4j:log4j-bom:2.24.2')
+  implementation platform('org.apache.logging.log4j:log4j-bom:2.24.3')
   implementation 'org.apache.logging.log4j:log4j-api' // log4j
   implementation 'org.apache.logging.log4j:log4j-core' // log4j
   implementation 'org.apache.logging.log4j:log4j-slf4j-impl' // log4j -> slf4j
 
   // Databases
   implementation 'org.influxdb:influxdb-java:2.24'
-  implementation 'com.couchbase.client:java-client:3.7.5'
+  implementation 'com.couchbase.client:java-client:3.7.6'
   runtimeOnly 'org.postgresql:postgresql:42.7.4' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.18.0' // I/O functionalities

docs/readthedocs/io/csvfiles.md

@@ -122,30 +122,34 @@ This is the UUID from the example above `2fcb3e53-b94a-4b96-bea4-c469e499f1a1`.
 The following keys are supported until now:
 ```{list-table}
    :widths: auto
+   :class: wrapping
    :header-rows: 1
 
    * - Key
-     - Information and supported head line
+     - Information and supported head line.
    * - c
      - An energy price (e.g. in €/MWh; c stands for charge).
        Permissible head line: ``time,price``
    * - p
-     - Active power
+     - Active power.
        Permissible head line: ``time,p``
    * - pq
-     - Active and reactive power
+     - Active and reactive power.
        Permissible head line: ``time,p,q``
    * - h
-     - Heat power demand
+     - Heat power demand.
        Permissible head line: ``time,h``
    * - ph
-     - Active and heat power
+     - Active and heat power.
        Permissible head line: ``time,p,h``
    * - pqh
-     - Active, reactive and heat power
+     - Active, reactive and heat power.
        Permissible head line: ``time,p,q,h``
+   * - v
+     - Voltage mangnitude in pu and angle in °.
+       Permissible head line: ``time,vMag,vAng``
    * - weather
-     - Weather information
+     - Weather information.
        Permissible head line: ``time,coordinate,direct_irradiation,diffuse_irradiation,temperature,wind_velocity,wind_direction``
 
 ```

docs/readthedocs/models/input/additionaldata/timeseries.md

@@ -48,7 +48,10 @@ The following different values are available:
      
    * - `WindValue`
      - Combination of wind direction and wind velocity
-        
+   
+   * - `VoltageValue`
+     - Combination of voltage magnitude in p.u. and angle in °
+   
    * - `WeatherValue`
      - Combination of irradiance, temperature and wind information
            

src/main/java/edu/ie3/datamodel/exceptions/EntityProcessorException.java

@@ -6,7 +6,7 @@
 package edu.ie3.datamodel.exceptions;
 
 /**
- * Is thrown, when an something went wrong during entity field mapping creation in a {@link
+ * Is thrown, when something went wrong during entity field mapping creation in a {@link
  * edu.ie3.datamodel.io.processor.EntityProcessor}
  */
 public class EntityProcessorException extends Exception {

src/main/java/edu/ie3/datamodel/io/factory/FactoryData.java

@@ -78,6 +78,22 @@ public <Q extends Quantity<Q>> ComparableQuantity<Q> getQuantity(String field, U
     return Quantities.getQuantity(getDouble(field), unit);
   }
 
+  /**
+   * Returns field value for given field name, or empty Optional if field does not exist.
+   *
+   * @param field field name
+   * @param unit unit of Quantity
+   * @param <Q> unit type parameter
+   * @return field value
+   */
+  public <Q extends Quantity<Q>> Optional<ComparableQuantity<Q>> getQuantityOptional(
+      String field, Unit<Q> unit) {
+    return Optional.ofNullable(fieldsToAttributes.get(field))
+        .filter(str -> !str.isEmpty())
+        .map(Double::parseDouble)
+        .map(value -> Quantities.getQuantity(value, unit));
+  }
+
   /**
    * Returns int value for given field name. Throws {@link FactoryException} if field does not exist
    * or parsing fails.

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

@@ -25,6 +25,10 @@ public class TimeBasedSimpleValueFactory<V extends Value>
   private static final String REACTIVE_POWER = "q";
   private static final String HEAT_DEMAND = "heatDemand";
 
+  /* voltage */
+  private static final String VMAG = "vMag";
+  private static final String VANG = "VAng";
+
   public TimeBasedSimpleValueFactory(Class<? extends V> valueClasses) {
     super(valueClasses);
   }
@@ -35,6 +39,7 @@ public TimeBasedSimpleValueFactory(
   }
 
   @Override
+  @SuppressWarnings("unchecked")
   protected TimeBasedValue<V> buildModel(SimpleTimeBasedValueData<V> data) {
     ZonedDateTime time = timeUtil.toZonedDateTime(data.getField(TIME));
     V value;
@@ -64,6 +69,12 @@ protected TimeBasedValue<V> buildModel(SimpleTimeBasedValueData<V> data) {
                   data.getQuantity(REACTIVE_POWER, REACTIVE_POWER_IN));
     } else if (PValue.class.isAssignableFrom(data.getTargetClass())) {
       value = (V) new PValue(data.getQuantity(ACTIVE_POWER, ACTIVE_POWER_IN));
+    } else if (VoltageValue.class.isAssignableFrom(data.getTargetClass())) {
+      value =
+          (V)
+              new VoltageValue(
+                  data.getQuantity(VMAG, VOLTAGE_MAGNITUDE),
+                  data.getQuantityOptional(VANG, VOLTAGE_ANGLE));
     } else {
       throw new FactoryException(
           "The given factory cannot handle target class '" + data.getTargetClass() + "'.");
@@ -88,6 +99,8 @@ protected List<Set<String>> getFields(Class<?> entityClass) {
       minConstructorParams.addAll(Arrays.asList(ACTIVE_POWER, REACTIVE_POWER));
     } else if (PValue.class.isAssignableFrom(entityClass)) {
       minConstructorParams.add(ACTIVE_POWER);
+    } else if (VoltageValue.class.isAssignableFrom(entityClass)) {
+      minConstructorParams.addAll(List.of(VMAG, VANG));
     } else {
       throw new FactoryException(
           "The given factory cannot handle target class '" + entityClass + "'.");

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

@@ -8,16 +8,13 @@
 import edu.ie3.datamodel.io.factory.EntityData;
 import edu.ie3.datamodel.io.factory.EntityFactory;
 import edu.ie3.datamodel.io.source.TimeSeriesMappingSource;
-import java.util.Collections;
 import java.util.List;
 import java.util.Set;
 import java.util.UUID;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 public class TimeSeriesMappingFactory
     extends EntityFactory<TimeSeriesMappingSource.MappingEntry, EntityData> {
-  private static final String PARTICIPANT = "participant";
+  private static final String ASSET = "asset";
   private static final String TIME_SERIES = "timeSeries";
 
   public TimeSeriesMappingFactory() {
@@ -26,14 +23,13 @@ public TimeSeriesMappingFactory() {
 
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
-    return Collections.singletonList(
-        Stream.of(PARTICIPANT, TIME_SERIES).collect(Collectors.toSet()));
+    return List.of(newSet(ASSET, TIME_SERIES));
   }
 
   @Override
   protected TimeSeriesMappingSource.MappingEntry buildModel(EntityData data) {
-    UUID participant = data.getUUID(PARTICIPANT);
+    UUID asset = data.getUUID(ASSET);
     UUID timeSeries = data.getUUID(TIME_SERIES);
-    return new TimeSeriesMappingSource.MappingEntry(participant, timeSeries);
+    return new TimeSeriesMappingSource.MappingEntry(asset, timeSeries);
   }
 }

src/main/java/edu/ie3/datamodel/io/naming/timeseries/ColumnScheme.java

@@ -19,7 +19,8 @@ public enum ColumnScheme {
   HEAT_DEMAND("h", HeatDemandValue.class),
   ACTIVE_POWER_AND_HEAT_DEMAND("ph", HeatAndPValue.class),
   APPARENT_POWER_AND_HEAT_DEMAND("pqh", HeatAndSValue.class),
-  WEATHER("weather", WeatherValue.class);
+  WEATHER("weather", WeatherValue.class),
+  VOLTAGE("v", VoltageValue.class);
 
   private final String scheme;
   private final Class<? extends Value> valueClass;
@@ -57,6 +58,7 @@ public static <V extends Value> Optional<ColumnScheme> parse(Class<V> valueClass
     if (PValue.class.isAssignableFrom(valueClass)) return Optional.of(ACTIVE_POWER);
     if (HeatDemandValue.class.isAssignableFrom(valueClass)) return Optional.of(HEAT_DEMAND);
     if (WeatherValue.class.isAssignableFrom(valueClass)) return Optional.of(WEATHER);
+    if (VoltageValue.class.isAssignableFrom(valueClass)) return Optional.of(VOLTAGE);
     return Optional.empty();
   }
 }

src/main/java/edu/ie3/datamodel/io/processor/EntityProcessor.java

@@ -55,7 +55,7 @@ protected EntityProcessor(Class<? extends T> registeredClass) throws EntityProce
    *     during processing
    */
   public LinkedHashMap<String, String> handleEntity(T entity) throws EntityProcessorException {
-    if (!registeredClass.equals(entity.getClass()))
+    if (!registeredClass.isAssignableFrom(entity.getClass()))
       throw new EntityProcessorException(
           "Cannot process "
               + entity.getClass().getSimpleName()

src/main/java/edu/ie3/datamodel/io/source/TimeSeriesMappingSource.java

@@ -11,7 +11,6 @@
 import edu.ie3.datamodel.io.factory.EntityData;
 import edu.ie3.datamodel.io.factory.timeseries.TimeSeriesMappingFactory;
 import edu.ie3.datamodel.models.input.InputEntity;
-import edu.ie3.datamodel.models.input.system.SystemParticipantInput;
 import edu.ie3.datamodel.models.timeseries.TimeSeries;
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.datamodel.utils.Try.*;
@@ -47,7 +46,7 @@ public Map<UUID, UUID> getMapping() throws SourceException {
         .filter(Try::isSuccess)
         .map(t -> (Success<MappingEntry, FactoryException>) t)
         .map(Success::get)
-        .collect(Collectors.toMap(MappingEntry::participant, MappingEntry::timeSeries));
+        .collect(Collectors.toMap(MappingEntry::getAsset, MappingEntry::getTimeSeries));
   }
 
   /**
@@ -80,12 +79,19 @@ private Try<MappingEntry, FactoryException> createMappingEntry(
 
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
-  /** Class to represent one entry within the participant to time series mapping */
-  public record MappingEntry(UUID participant, UUID timeSeries) implements InputEntity {
+  /** Class to represent one entry within the asset to time series mapping */
+  public static class MappingEntry implements InputEntity {
+    private final UUID asset;
+    private final UUID timeSeries;
 
-    /** Returns the {@link UUID} of the {@link SystemParticipantInput}. */
-    public UUID getParticipant() {
-      return participant;
+    public MappingEntry(UUID asset, UUID timeSeries) {
+      this.asset = asset;
+      this.timeSeries = timeSeries;
+    }
+
+    /** Returns the {@link UUID} of the {@link edu.ie3.datamodel.models.input.AssetInput}. */
+    public UUID getAsset() {
+      return asset;
     }
 
     /** Returns the {@link UUID} of the {@link TimeSeries}. */
@@ -97,17 +103,17 @@ public UUID getTimeSeries() {
     public boolean equals(Object o) {
       if (this == o) return true;
       if (!(o instanceof MappingEntry that)) return false;
-      return participant.equals(that.participant) && timeSeries.equals(that.timeSeries);
+      return asset.equals(that.asset) && timeSeries.equals(that.timeSeries);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hash(participant, timeSeries);
+      return Objects.hash(asset, timeSeries);
     }
 
     @Override
     public String toString() {
-      return "MappingEntry{" + "participant=" + participant + ", timeSeries=" + timeSeries + '}';
+      return "MappingEntry{" + "asset=" + asset + ", timeSeries=" + timeSeries + '}';
     }
   }
 }