Merge branch 'dev' into df/#1352-air-condition-input

danielfeismann · danielfeismann · commit 031499b2a04d · 2025-10-13T15:34:21.000+02:00
# Conflicts:
#	CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,13 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added weathersource documentation [#1390](https://github.com/ie3-institute/PowerSystemDataModel/issues/1390)
 - Added standard asset parameter for `3wTransformer` in `ReadTheDocs` [#1417](https://github.com/ie3-institute/PowerSystemDataModel/issues/1417)
+- Added getter sRated for SystemParticipant inputs and updated them in tests in src[#1412](https://github.com/ie3-institute/PowerSystemDataModel/issues/1412)
+- Added converters documentation [#1139](https://github.com/ie3-institute/PowerSystemDataModel/issues/1139)
 - Create data model for air condition [#1396](https://github.com/ie3-institute/PowerSystemDataModel/issues/1396)
 
 ### Fixed
 - Fixed small issues in tests [#1400](https://github.com/ie3-institute/PowerSystemDataModel/issues/1400)
 - Fix transformer susceptance in readTheDocs to negative values [#1078](https://github.com/ie3-institute/PowerSystemDataModel/issues/1078)
 - Added mising fields to field validation [#1422](https://github.com/ie3-institute/PowerSystemDataModel/issues/1422)
 - Fixed the issues with rtd for Cylindrical thermal storage [#1273](https://github.com/ie3-institute/PowerSystemDataModel/issues/1273)
+- Updated Controlling_em for all the loads in readthedocs[#1447](https://github.com/ie3-institute/PowerSystemDataModel/issues/1447)
 
 ### Changed
 - Updated CI-Pipeline to run task `Deploy` and `Staging` only for `Main` [#1403](https://github.com/ie3-institute/PowerSystemDataModel/issues/1403)
diff --git a/build.gradle b/build.gradle
@@ -20,7 +20,7 @@ ext {
   groovyVersion = "4.0"
   groovyBinaryVersion = "4.0.28"
 
-  junitVersion = '1.12.0'
+  junitVersion = '6.0.0'
   testcontainersVersion = '1.21.3'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
@@ -82,7 +82,7 @@ dependencies {
   testImplementation "org.junit.jupiter:junit-jupiter:$junitVersion"
   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.7' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.17.8' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -99,7 +99,7 @@ dependencies {
 
   // Databases
   implementation 'org.influxdb:influxdb-java:2.25'
-  implementation 'com.couchbase.client:java-client:3.9.1'
+  implementation 'com.couchbase.client:java-client:3.9.2'
   runtimeOnly 'org.postgresql:postgresql:42.7.8' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.20.0' // I/O functionalities
diff --git a/docs/readthedocs/io/basiciousage.md b/docs/readthedocs/io/basiciousage.md
@@ -12,6 +12,7 @@ csvfiles
 sql
 influxdb
 ValidationUtils.md
+converters.md
 ```
 
 ## Data sink structure
diff --git a/docs/readthedocs/io/converters.md b/docs/readthedocs/io/converters.md
@@ -0,0 +1,17 @@
+# Converters
+This page lists all converters from and to the PSDM format that are known to us.
+
+## Converters to PSDM
+
+- [simBench2psdm](https://github.com/ie3-institute/simBench2psdm): SimBench has been research project of Kassel university, Fraunhofer IEE, RWTH Aachen university and TU Dortmund university, aiming at provision of realistic models of electrical distribution grids including time series. The data is availabe [here](https://simbench.de).
+- [powerFactory2psdm](https://github.com/ie3-institute/powerFactory2psdm): This tool is used to convert PowerFactory projects into the PSDM format.
+- [pp2psdm](https://github.com/ie3-institute/pp2psdm): Converter for grid models from pandapower into PowerSystemDataModel format.
+
+## Converts from PSDM
+
+- [psdm2powerfactory](https://github.com/ie3-institute/psdm2powerfactory): Converter from PSDM to PowerFactory file format.
+
+## Other Converters
+
+- [simBench2PowerFactory](https://github.com/ie3-institute/simBench2PowerFactory): Converts SimBench grids to the PowerFactory file format.
+- The tool [here](https://github.com/e2nIEE/simbench) enables the use of the SimBench data set in the simulation tool [pandapower](https://github.com/e2nIEE/pandapower).
diff --git a/docs/readthedocs/models/input/em.md b/docs/readthedocs/models/input/em.md
@@ -40,7 +40,7 @@ Participants are connected to an EM each via their `em` field.
    * - controllingEm
      -
      - Reference to a superior Energy Management Unit that is controlling this EM.
-       Field can be empty or missing, if this EM itself is not controlled.
+       Field can be empty, if this EM itself is not controlled.
 
 ```
 
diff --git a/docs/readthedocs/models/input/participant/bm.md b/docs/readthedocs/models/input/participant/bm.md
@@ -110,7 +110,7 @@ Model of a biomass power plant.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/chp.md b/docs/readthedocs/models/input/participant/chp.md
@@ -117,7 +117,7 @@ Combined heat and power plant.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/ev.md b/docs/readthedocs/models/input/participant/ev.md
@@ -100,7 +100,7 @@ Model of an electric vehicle, that is occasionally connected to the grid via an
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/evcs.md b/docs/readthedocs/models/input/participant/evcs.md
@@ -66,7 +66,7 @@ station and has some limitations outlined below.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/fixedfeedin.md b/docs/readthedocs/models/input/participant/fixedfeedin.md
@@ -52,7 +52,7 @@ model can be derived.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/hp.md b/docs/readthedocs/models/input/participant/hp.md
@@ -96,7 +96,7 @@ Model of a heat pump.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 
diff --git a/docs/readthedocs/models/input/participant/load.md b/docs/readthedocs/models/input/participant/load.md
@@ -59,7 +59,7 @@ Model of (mainly) domestic loads.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/pv.md b/docs/readthedocs/models/input/participant/pv.md
@@ -78,7 +78,7 @@ Detailed model of a photovoltaic power plant.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/storage.md b/docs/readthedocs/models/input/participant/storage.md
@@ -110,7 +110,7 @@ Model of an ideal electrical battery energy storage.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/docs/readthedocs/models/input/participant/wec.md b/docs/readthedocs/models/input/participant/wec.md
@@ -109,7 +109,7 @@ Model of a wind energy converter.
    * - controllingEm
      -
      - UUID reference to an [Energy Management Unit](#em_model) that is controlling
-       this system participant. Field can be empty or missing, if this participant
+       this system participant. Field can be empty, if this participant
        is not controlled.
 
 ```
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java
@@ -16,6 +16,7 @@
 import edu.ie3.util.quantities.interfaces.EnergyPrice;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
 import tech.units.indriya.ComparableQuantity;
 
 /** Describes a biomass plant */
@@ -117,6 +118,11 @@ public ComparableQuantity<EnergyPrice> getFeedInTariff() {
     return feedInTariff;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public BmInputCopyBuilder copy() {
     return new BmInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java
@@ -18,6 +18,8 @@
 import edu.ie3.datamodel.models.input.thermal.ThermalStorageInput;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes a combined heat and power plant */
 public class ChpInput extends SystemParticipantInput
@@ -119,6 +121,11 @@ public boolean isMarketReaction() {
     return marketReaction;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public ChpInputCopyBuilder copy() {
     return new ChpInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/EvInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/EvInput.java
@@ -14,6 +14,8 @@
 import edu.ie3.datamodel.models.input.system.type.EvTypeInput;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes an electric vehicle */
 public class EvInput extends SystemParticipantInput implements HasType {
@@ -71,6 +73,11 @@ public EvTypeInput getType() {
     return type;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public EvInputCopyBuilder copy() {
     return new EvInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java
@@ -14,6 +14,8 @@
 import edu.ie3.datamodel.models.input.system.type.evcslocation.EvcsLocationType;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 public class EvcsInput extends SystemParticipantInput {
 
@@ -182,6 +184,11 @@ public boolean getV2gSupport() {
     return v2gSupport;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   @Override
   public EvcsInputCopyBuilder copy() {
     return new EvcsInputCopyBuilder(this);
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java
@@ -80,6 +80,11 @@ public ComparableQuantity<Power> getsRated() {
     return sRated;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return sRated;
+  }
+
   public double getCosPhiRated() {
     return cosPhiRated;
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java
@@ -16,6 +16,8 @@
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes a heat pump */
 public class HpInput extends SystemParticipantInput implements HasType, HasThermalBus {
@@ -87,6 +89,11 @@ public ThermalBusInput getThermalBus() {
     return thermalBus;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public HpInputCopyBuilder copy() {
     return new HpInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java
@@ -199,6 +199,11 @@ public ComparableQuantity<Power> getsRated() {
     return sRated;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return sRated;
+  }
+
   public double getCosPhiRated() {
     return cosPhiRated;
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java
@@ -178,6 +178,11 @@ public ComparableQuantity<Power> getsRated() {
     return sRated;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return sRated;
+  }
+
   public PvInputCopyBuilder copy() {
     return new PvInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/StorageInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/StorageInput.java
@@ -14,6 +14,8 @@
 import edu.ie3.datamodel.models.input.system.type.StorageTypeInput;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes a battery storage */
 public class StorageInput extends SystemParticipantInput implements HasType {
@@ -71,6 +73,11 @@ public StorageTypeInput getType() {
     return type;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public StorageInputCopyBuilder copy() {
     return new StorageInputCopyBuilder(this);
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java
@@ -15,6 +15,8 @@
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.system.characteristic.ReactivePowerCharacteristic;
 import java.util.*;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes a system asset that is connected to a node */
 public abstract class SystemParticipantInput extends AssetInput implements HasNodes, HasEm {
@@ -77,6 +79,18 @@ protected SystemParticipantInput(
     this.controllingEm = em;
   }
 
+  /**
+   * Returns the rated apparent power of the system participant, which is either stored within the
+   * {@link SystemParticipantInput} or linked {@link
+   * edu.ie3.datamodel.models.input.system.type.SystemParticipantTypeInput}.
+   *
+   * <p>Note: This cannot be a getter, because the accompanying field might not be present in
+   * subclasses.
+   *
+   * @return The rated apparent power.
+   */
+  public abstract ComparableQuantity<Power> sRated();
+
   public NodeInput getNode() {
     return node;
   }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java
@@ -14,6 +14,8 @@
 import edu.ie3.datamodel.models.input.system.type.WecTypeInput;
 import java.util.Objects;
 import java.util.UUID;
+import javax.measure.quantity.Power;
+import tech.units.indriya.ComparableQuantity;
 
 /** Describes a Wind Energy Converter */
 public class WecInput extends SystemParticipantInput implements HasType {
@@ -85,6 +87,11 @@ public WecTypeInput getType() {
     return type;
   }
 
+  @Override
+  public ComparableQuantity<Power> sRated() {
+    return this.type.getsRated();
+  }
+
   public WecInputCopyBuilder copy() {
     return new WecInputCopyBuilder(this);
   }
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/BmInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/BmInputTest.groovy
@@ -55,6 +55,7 @@ class BmInputTest extends Specification {
       assert qCharacteristics == bmInput.qCharacteristics
       assert feedInTariff == bmInput.feedInTariff
       assert type.sRated == bmInput.type.sRated * 2d
+      assert sRated() == bmInput.type.sRated * 2d
       assert controllingEm == Optional.of(SystemParticipantTestData.emInput)
     }
   }
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/ChpInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/ChpInputTest.groovy
@@ -51,6 +51,7 @@ class ChpInputTest extends Specification {
       assert thermalStorage == chpInput.thermalStorage
       assert marketReaction == chpInput.marketReaction
       assert type.sRated == chpInput.type.sRated * 2d
+      assert sRated() == chpInput.type.sRated * 2d
       assert type.pThermal == chpInput.type.pThermal * 2d
       assert type.pOwn == chpInput.type.pOwn * 2d
       assert controllingEm == Optional.of(SystemParticipantTestData.emInput)
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/EvInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/EvInputTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/EvcsInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/EvcsInputTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/HpInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/HpInputTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/StorageInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/StorageInputTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/models/input/system/WecInputTest.groovy b/src/test/groovy/edu/ie3/datamodel/models/input/system/WecInputTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/utils/validation/InvalidSystemParticipantInput.groovy b/src/test/groovy/edu/ie3/datamodel/utils/validation/InvalidSystemParticipantInput.groovy

Original file line number	Diff line number	Diff line change
@@ -40,7 +40,7 @@ Participants are connected to an EM each via their `em` field.
`40`	`40`	`* - controllingEm`
`41`	`41`	`-`
`42`	`42`	`- Reference to a superior Energy Management Unit that is controlling this EM.`
`43`		`- Field can be empty or missing, if this EM itself is not controlled.`
	`43`	`+ Field can be empty, if this EM itself is not controlled.`
`44`	`44`
`45`	`45`	```
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ Model of a biomass power plant.`
`110`	`110`	`* - controllingEm`
`111`	`111`	`-`
`112`	`112`	`- UUID reference to an [Energy Management Unit](#em_model) that is controlling`
`113`		`- this system participant. Field can be empty or missing, if this participant`
	`113`	`+ this system participant. Field can be empty, if this participant`
`114`	`114`	`is not controlled.`
`115`	`115`
`116`	`116`	```
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ Combined heat and power plant.`
`117`	`117`	`* - controllingEm`
`118`	`118`	`-`
`119`	`119`	`- UUID reference to an [Energy Management Unit](em_model) that is controlling`
`120`		`- this system participant. Field can be empty or missing, if this participant`
	`120`	`+ this system participant. Field can be empty, if this participant`
`121`	`121`	`is not controlled.`
`122`	`122`
`123`	`123`	```
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ Model of an electric vehicle, that is occasionally connected to the grid via an`
`100`	`100`	`* - controllingEm`
`101`	`101`	`-`
`102`	`102`	`- UUID reference to an [Energy Management Unit](#em_model) that is controlling`
`103`		`- this system participant. Field can be empty or missing, if this participant`
	`103`	`+ this system participant. Field can be empty, if this participant`
`104`	`104`	`is not controlled.`
`105`	`105`
`106`	`106`	```
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ station and has some limitations outlined below.`
`66`	`66`	`* - controllingEm`
`67`	`67`	`-`
`68`	`68`	`- UUID reference to an [Energy Management Unit](#em_model) that is controlling`
`69`		`- this system participant. Field can be empty or missing, if this participant`
	`69`	`+ this system participant. Field can be empty, if this participant`
`70`	`70`	`is not controlled.`
`71`	`71`
`72`	`72`	```
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ model can be derived.`
`52`	`52`	`* - controllingEm`
`53`	`53`	`-`
`54`	`54`	`- UUID reference to an [Energy Management Unit](#em_model) that is controlling`
`55`		`- this system participant. Field can be empty or missing, if this participant`
	`55`	`+ this system participant. Field can be empty, if this participant`
`56`	`56`	`is not controlled.`
`57`	`57`
`58`	`58`	```