Merge branch 'dev' into rel/df/#1398-release_8.1.0

# Conflicts:
#	version.properties

Author: danielfeismann

CHANGELOG.md

@@ -7,15 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased/Snapshot]
 
 ### Added
-
-### Fixed
+- Enhanced check for invalid field names in sources [#1383](https://github.com/ie3-institute/PowerSystemDataModel/issues/1383)
+- Enhancing value retrieval in `TimeSeriesSource` [1280](https://github.com/ie3-institute/PowerSystemDataModel/issues/1280)
+- Enhancing the `LoadProfileSource` to return the resolution [1288](https://github.com/ie3-institute/PowerSystemDataModel/issues/1288)
+- Enhancing Validation for sRated of `HpTypeInput` [1394](https://github.com/ie3-institute/PowerSystemDataModel/issues/1394)
+- Added updated `BdewStandardLoadProfiles` [#1292](https://github.com/ie3-institute/PowerSystemDataModel/issues/1292)
 
 ### Changed
+- Fixed CFF-Version [#1392](https://github.com/ie3-institute/PowerSystemDataModel/issues/1392)
+- Enhanced `ValidationUtils` for `LoadModel` to check for correct profile naming [#1357](https://github.com/ie3-institute/PowerSystemDataModel/issues/1357)
 
 ## [8.0.0] - 2025-07-22
 
 ### Added
 - Extend Validation to EnergyManagement Systems. [#1356](https://github.com/ie3-institute/PowerSystemDataModel/issues/1356)
+- Added `CITATION.cff` [#1380](https://github.com/ie3-institute/PowerSystemDataModel/issues/1380)
 
 ### Fixed
 - Fixed handling of `CongestionResult.InputModelType` in `EntityProcessor` [#1325](https://github.com/ie3-institute/PowerSystemDataModel/issues/1325)
@@ -379,7 +385,7 @@ coordinates or multiple exactly equal coordinates possible
 -   CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
 -   CsvDataSource now parsing multiple geoJson strings correctly
 
-[Unreleased/Snapshot]: 
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/8.0.0...HEAD
 [8.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/7.0.0...8.0.0
 [7.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/6.0.0...7.0.0
 [6.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.1.0...6.0.0

CITATION.cff

@@ -0,0 +1,65 @@
+cff-version: 1.2.0
+title: "PowerSystemDataModel - Provides an elaborated data model to model energy systems with a high granularity."
+message: "If you use this software, please cite it as below."
+type: software
+authors:
+  - name: "ie³ - Institute of Energy Systems, Energy Efficiency and Energy Economics - TU Dortmund University"
+    alias: ie³
+    address: "Martin-Schmeißer-Weg 12"
+    city: Dortmund
+    country: DE
+    post-code: 44227
+    website: "https://ie3.etit.tu-dortmund.de/"
+  - family-names: Hiry
+    given-names: Johannes
+    orcid: https://orcid.org/0000-0002-1447-0607
+  - family-names: Kittl
+    given-names: Chris
+    orcid: https://orcid.org/0000-0002-1187-0568
+  - family-names: Sen-Sarma
+    given-names: Debopama        
+  - family-names: Peter
+    given-names: Sebastian
+    orcid: https://orcid.org/0000-0001-6311-6113
+  - family-names: Oberließen
+    given-names: Thomas
+    orcid: https://orcid.org/0000-0001-5805-5408
+  - family-names: Feismann
+    given-names: Daniel
+    orcid: https://orcid.org/0000-0002-3531-9025
+  - family-names: Bao
+    given-names: Johannes
+    orcid: https://orcid.org/0009-0008-3641-6469
+  - family-names: Hohmann
+    given-names: Julian
+  - family-names: Staudt
+    given-names: Marius
+    orcid: https://orcid.org/0009-0005-3309-5258
+  - family-names: Steffan
+    given-names: Niklas
+  - family-names: Kraus
+    given-names: Mia
+  - family-names: Strehle
+    given-names: Dennis
+  - family-names: Mahr
+    given-names: Christian
+  - family-names: Zachopoulos
+    given-names: Vasilios
+  - family-names: Bajpai
+    given-names: Shubham
+  - family-names: Roumeliotis
+    given-names: Lara
+  - family-names: Bung
+    given-names: Vicky
+  - family-names: Hütte
+    given-names: Simon
+  - family-names: Petersmeier
+    given-names: Pierre
+repository-code: https://github.com/ie3-institute/PowerSystemDataModel
+keywords:
+  - power system data model
+  - power system
+  - energy system
+license: BSD-3-Clause
+version: 7.0.0
+date-released: 2025-06-05

build.gradle

@@ -4,7 +4,7 @@ plugins {
   id 'maven-publish'
   id 'signing'
   id 'pmd' // code check, working on source code
-  id 'com.diffplug.spotless' version '7.1.0' //code format
+  id 'com.diffplug.spotless' version '7.2.1' //code format
   id 'com.github.spotbugs' version '6.2.2' // code check, working on byte code
   id 'de.undercouch.download' version '5.6.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
@@ -18,7 +18,7 @@ ext {
   //version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
-  groovyBinaryVersion = "4.0.27"
+  groovyBinaryVersion = "4.0.28"
 
   junitVersion = '1.12.0'
   testcontainersVersion = '1.21.3'
@@ -102,8 +102,8 @@ dependencies {
   implementation 'com.couchbase.client:java-client:3.8.3'
   runtimeOnly 'org.postgresql:postgresql:42.7.7' // postgresql jdbc driver required during runtime
 
-  implementation 'commons-io:commons-io:2.19.0' // I/O functionalities
-  implementation 'commons-codec:commons-codec:1.18.0' // needed by commons-compress
+  implementation 'commons-io:commons-io:2.20.0' // I/O functionalities
+  implementation 'commons-codec:commons-codec:1.19.0' // needed by commons-compress
   implementation 'org.apache.commons:commons-compress:1.27.1' // I/O functionalities
 }
 

docs/readthedocs/io/csvfiles.md

@@ -169,8 +169,11 @@ The following profiles are supported until now:
      - Information
      - Supported head line.
    * - e.g.: H0
-     - BDEW standard load profiles ([source](https://www.bdew.de/energie/standardlastprofile-strom/))
+     - BDEW standard load profiles 1999 ([source](https://www.bdew.de/energie/standardlastprofile-strom/))
      - Permissible head line: ``SuSa,SuSu,SuWd,TrSa,TrSu,TrWd,WiSa,WiSu,WiWd,quarterHour``
+   * - e.g.: h25
+     - BDEW standard load profiles 2025 ([source](https://www.bdew.de/energie/standardlastprofile-strom/))
+     - Permissible head line: ``janSa,janSu,janWd,febSa,febSu,febWd,marSa,marSu,marWd,aprSa,aprSu,aprWd,maySa,maySu,mayWd,junSa,junSu,junWd,julSa,julSu,julWd,augSa,augSu,augWd,sepSa,sepSu,sepWd,octSa,octSu,octWd,novSa,novSu,novWd,decSa,decSu,decWd,quarterHour``
    * - random
      - A random load proile based on: ``Kays - Agent-based simulation environment for improving the planning of distribution grids``
      - Permissible head line: ``kSa,kSu,kWd,mySa,mySu,myWd,sigmaSa,sigmaSu,sigmaWd,quarterHour``

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

@@ -174,10 +174,11 @@ public Try<Void, ValidationException> validate(
                   + "' are possible (NOT case-sensitive!):\n"
                   + possibleOptions));
     } else {
+      // find all unused fields
       Set<String> unused = getUnusedFields(harmonizedActualFields, validFieldSets);
 
       if (!unused.isEmpty()) {
-        log.debug(
+        log.info(
             "The following additional fields were found for entity class of '{}': {}",
             entityClass.getSimpleName(),
             unused);

src/main/java/edu/ie3/datamodel/io/factory/input/participant/SystemParticipantInputEntityFactory.java

@@ -30,23 +30,26 @@ public abstract class SystemParticipantInputEntityFactory<
         T extends SystemParticipantInput, D extends SystemParticipantEntityData>
     extends AssetInputEntityFactory<T, D> {
 
+  private static final String NODE = "node";
+
   private static final String Q_CHARACTERISTICS = "qCharacteristics";
 
   public static final String CONTROLLING_EM = "controllingEm";
 
+  @SafeVarargs
   protected SystemParticipantInputEntityFactory(Class<? extends T>... allowedClasses) {
     super(allowedClasses);
   }
 
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
     List<Set<String>> fields = new ArrayList<>(super.getFields(entityClass));
-    for (Set<String> set : fields) set.add(Q_CHARACTERISTICS);
-
-    List<Set<String>> withEm =
-        fields.stream().map(f -> (Set<String>) expandSet(f, CONTROLLING_EM)).toList();
 
-    fields.addAll(withEm);
+    for (Set<String> set : fields) {
+      set.add(Q_CHARACTERISTICS);
+      set.add(NODE);
+      set.add(CONTROLLING_EM);
+    }
 
     return fields;
   }

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

@@ -15,66 +15,57 @@
 import edu.ie3.datamodel.models.timeseries.repetitive.BdewLoadProfileTimeSeries;
 import edu.ie3.datamodel.models.timeseries.repetitive.LoadProfileEntry;
 import edu.ie3.datamodel.models.value.load.BdewLoadValues;
-import java.util.*;
+import edu.ie3.datamodel.models.value.load.BdewLoadValues.BdewKey;
+import edu.ie3.datamodel.models.value.load.BdewLoadValues.BdewScheme;
+import edu.ie3.util.quantities.PowerSystemUnits;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 import java.util.function.Function;
-import java.util.stream.Stream;
 import javax.measure.quantity.Energy;
 import javax.measure.quantity.Power;
 import tech.units.indriya.ComparableQuantity;
 import tech.units.indriya.quantity.Quantities;
 
 public class BdewLoadProfileFactory
     extends LoadProfileFactory<BdewStandardLoadProfile, BdewLoadValues> {
-  public static final String SUMMER_SATURDAY = "SuSa";
-  public static final String SUMMER_SUNDAY = "SuSu";
-  public static final String SUMMER_WEEKDAY = "SuWd";
-  public static final String TRANSITION_SATURDAY = "TrSa";
-  public static final String TRANSITION_SUNDAY = "TrSu";
-  public static final String TRANSITION_WEEKDAY = "TrWd";
-  public static final String WINTER_SATURDAY = "WiSa";
-  public static final String WINTER_SUNDAY = "WiSu";
-  public static final String WINTER_WEEKDAY = "WiWd";
+  // 1999 profile scheme
+  public static final BdewLoadValues.BdewMap<String> BDEW1999_FIELDS =
+      BdewKey.toMap(BdewScheme.BDEW1999);
 
-  public BdewLoadProfileFactory() {
-    this(BdewLoadValues.class);
-  }
+  // 2025 profile scheme
+  public static final BdewLoadValues.BdewMap<String> BDEW2025_FIELDS =
+      BdewKey.toMap(BdewScheme.BDEW2025);
 
-  public BdewLoadProfileFactory(Class<BdewLoadValues> valueClass) {
-    super(valueClass);
+  public BdewLoadProfileFactory() {
+    super(BdewLoadValues.class);
   }
 
   @Override
   protected LoadProfileEntry<BdewLoadValues> buildModel(LoadProfileData<BdewLoadValues> data) {
     int quarterHour = data.getInt(QUARTER_HOUR);
 
-    return new LoadProfileEntry<>(
-        new BdewLoadValues(
-            data.getDouble(SUMMER_SATURDAY),
-            data.getDouble(SUMMER_SUNDAY),
-            data.getDouble(SUMMER_WEEKDAY),
-            data.getDouble(TRANSITION_SATURDAY),
-            data.getDouble(TRANSITION_SUNDAY),
-            data.getDouble(TRANSITION_WEEKDAY),
-            data.getDouble(WINTER_SATURDAY),
-            data.getDouble(WINTER_SUNDAY),
-            data.getDouble(WINTER_WEEKDAY)),
-        quarterHour);
+    boolean is1999Scheme =
+        data.containsKey("SuSa") || data.containsKey("su_sa") || data.containsKey("suSa");
+
+    BdewLoadValues values;
+
+    if (is1999Scheme) {
+      values = new BdewLoadValues(BdewScheme.BDEW1999, BDEW1999_FIELDS.map(data::getDouble));
+
+    } else {
+      values = new BdewLoadValues(BdewScheme.BDEW2025, BDEW2025_FIELDS.map(data::getDouble));
+    }
+
+    return new LoadProfileEntry<>(values, quarterHour);
   }
 
   @Override
   protected List<Set<String>> getFields(Class<?> entityClass) {
     return List.of(
-        newSet(
-            QUARTER_HOUR,
-            SUMMER_SATURDAY,
-            SUMMER_SUNDAY,
-            SUMMER_WEEKDAY,
-            TRANSITION_SATURDAY,
-            TRANSITION_SUNDAY,
-            TRANSITION_WEEKDAY,
-            WINTER_SATURDAY,
-            WINTER_SUNDAY,
-            WINTER_WEEKDAY));
+        expandSet(new HashSet<>(BDEW1999_FIELDS.values()), QUARTER_HOUR),
+        expandSet(new HashSet<>(BDEW2025_FIELDS.values()), QUARTER_HOUR));
   }
 
   @Override
@@ -101,26 +92,35 @@ public BdewStandardLoadProfile parseProfile(String profile) {
   @Override
   public ComparableQuantity<Power> calculateMaxPower(
       BdewStandardLoadProfile loadProfile, Set<LoadProfileEntry<BdewLoadValues>> entries) {
-    Function<BdewLoadValues, Stream<Double>> valueExtractor;
-
-    if (loadProfile == BdewStandardLoadProfile.H0) {
-      // maximum dynamization factor is on day 366 (leap year) or day 365 (regular year).
-      // The difference between day 365 and day 366 is negligible, thus pick 366
-      valueExtractor =
-          v ->
-              Stream.of(v.getWiSa(), v.getWiSu(), v.getWiWd())
-                  .map(p -> BdewLoadValues.dynamization(p, 366));
-    } else {
-      valueExtractor = v -> v.values().stream();
-    }
+    Function<BdewLoadValues, Double> valueExtractor =
+        switch (loadProfile) {
+          case H0, H25, P25, S25 ->
+          // maximum dynamization factor is on day 366 (leap year) or day 365 (regular year).
+          // The difference between day 365 and day 366 is negligible, thus pick 366
+          v -> BdewLoadValues.dynamization(v.getMaxValue(true), 366);
+          default -> v -> v.getMaxValue(false);
+        };
 
     double maxPower =
         entries.stream()
             .map(TimeSeriesEntry::getValue)
-            .flatMap(valueExtractor)
+            .map(valueExtractor)
             .max(Comparator.naturalOrder())
             .orElse(0d);
 
     return Quantities.getQuantity(maxPower, WATT);
   }
+
+  /** Returns the load profile energy scaling. The default value is 1000 kWh */
+  @Override
+  public ComparableQuantity<Energy> getLoadProfileEnergyScaling(
+      BdewStandardLoadProfile loadProfile) {
+
+    // the updated profiled are scaled to 1 million kWh -> 1000 MWh
+    // old profiles are scaled to 1000 kWh
+    return switch (loadProfile) {
+      case H25, G25, L25, P25, S25 -> Quantities.getQuantity(1000d, PowerSystemUnits.MEGAWATTHOUR);
+      default -> Quantities.getQuantity(1000d, PowerSystemUnits.KILOWATTHOUR);
+    };
+  }
 }

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

@@ -32,6 +32,11 @@ public LoadProfileFactory(Class<? extends V> valueClass) {
     super(valueClass);
   }
 
+  @SafeVarargs
+  protected LoadProfileFactory(Class<? extends V>... valueClass) {
+    super(valueClass);
+  }
+
   public abstract LoadProfileTimeSeries<V> build(
       LoadProfileMetaInformation metaInformation, Set<LoadProfileEntry<V>> entries);
 

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

@@ -9,10 +9,12 @@
 import edu.ie3.datamodel.models.Entity;
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.utils.Try;
-import edu.ie3.datamodel.utils.Try.*;
+import edu.ie3.datamodel.utils.Try.Failure;
+import edu.ie3.datamodel.utils.Try.Success;
 import edu.ie3.util.exceptions.QuantityException;
-import java.lang.reflect.Method;
-import java.util.*;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.SortedMap;
 import javax.measure.Quantity;
 import javax.measure.quantity.Energy;
 import javax.measure.quantity.Power;
@@ -31,7 +33,7 @@ public abstract class EntityProcessor<T extends Entity> extends Processor<T> {
 
   public static final Logger log = LoggerFactory.getLogger(EntityProcessor.class);
   protected final String[] headerElements;
-  private final SortedMap<String, Method> fieldNameToMethod;
+  private final SortedMap<String, GetterMethod> fieldNameToMethod;
 
   private static final String NODE_INTERNAL = "nodeInternal";
 

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

@@ -0,0 +1,27 @@
+/*
+ * © 2025. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.processor;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+public record GetterMethod(String name, Getter getter, String returnType) {
+
+  public GetterMethod(Method method) {
+    this(method.getName(), method::invoke, method.getReturnType().getSimpleName());
+  }
+
+  public Object invoke(Object object)
+      throws IllegalAccessException, IllegalArgumentException, InvocationTargetException {
+    return getter.get(object);
+  }
+
+  @FunctionalInterface
+  public interface Getter {
+    Object get(Object object)
+        throws IllegalAccessException, IllegalArgumentException, InvocationTargetException;
+  }
+}