Merge pull request #1108 from ie3-institute/rel/sp/#1107-release-5.1

Release version 5.1

Author: sebastian-peter

CHANGELOG.md

@@ -6,6 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+
+### Fixed
+
+### Changed
+
+## [5.1.0] - 2024-06-24
+
+### Added
+- Enhancing `VoltageLevel` with `equals` method [#1063](https://github.com/ie3-institute/PowerSystemDataModel/issues/1063)
+- `ConnectorValidationUtils` checks if parallel devices is > 0 [#1077](https://github.com/ie3-institute/PowerSystemDataModel/issues/1077)
+- `GridContainerValidationUtils` checks the connectivity for all defined operation time intervals [#1091](https://github.com/ie3-institute/PowerSystemDataModel/issues/1091)
+- Implemented a `CongestionResult` [#1097](https://github.com/ie3-institute/PowerSystemDataModel/issues/1097)
+
+### Fixed
+- Fixed `MappingEntryies` not getting processed by adding `Getter` methods for record fields [#1084](https://github.com/ie3-institute/PowerSystemDataModel/issues/1084) 
+- Fixed "depth of discharge" in documentation [#872](https://github.com/ie3-institute/PowerSystemDataModel/issues/872)
+- Fixed project being build twice in CI [#994](https://github.com/ie3-institute/PowerSystemDataModel/issues/994)
+
+### Changed
+- Improvements to the search for corner points in `IdCoordinateSource` [#1016](https://github.com/ie3-institute/PowerSystemDataModel/issues/1016)
+- Refactor `CsvFileConnector` and `CsvDataSource` [#1007](https://github.com/ie3-institute/PowerSystemDataModel/issues/1007)
+- Make `EntitySource` completely static [#975](https://github.com/ie3-institute/PowerSystemDataModel/issues/975)
+- Abstract commonly used functionality from `EntitySource` [#981](https://github.com/ie3-institute/PowerSystemDataModel/issues/981)
+
 ## [5.0.1] - 2024-03-07
 
 ### Fixed
@@ -277,9 +302,10 @@ 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]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.1...HEAD
-[5.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.0...5.0.1
-[4.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.1.0...5.0.0
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.1.0...HEAD
+[5.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.1...5.1.0
+[5.0.1]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.0...5.0.1
+[5.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.1.0...5.0.0
 [4.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/3.0.0...4.0.0
 [3.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.1.0...3.0.0

Jenkinsfile

@@ -113,7 +113,7 @@ node {
         gradle('--refresh-dependencies clean spotlessCheck pmdMain pmdTest spotbugsMain ' +
             'spotbugsTest test jacocoTestReport jacocoTestCoverageVerification', projectName)
 
-        sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew clean javadoc''', returnStdout: true)
+        sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew javadoc''', returnStdout: true)
       }
 
       // sonarqube analysis
@@ -156,7 +156,7 @@ node {
              */
             sh(
                 script: """set +x && cd $projectName""" +
-                ''' set +x; ./gradlew clean javadoc''',
+                ''' set +x; ./gradlew javadoc''',
                 returnStdout: true
                 )
 

build.gradle

@@ -5,20 +5,20 @@ 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.8' // code check, working on byte code
+  id 'com.github.spotbugs' version '6.0.18' // 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 "4.4.1.3373" // sonarqube
+  id "org.sonarqube" version "5.0.0.4638" // sonarqube
   id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
 }
 
 ext {
   //version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
-  groovyBinaryVersion = "4.0.19"
-  testcontainersVersion = '1.19.7'
+  groovyBinaryVersion = "4.0.21"
+  testcontainersVersion = '1.19.8'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
@@ -72,8 +72,8 @@ dependencies {
 
   testImplementation 'org.junit.jupiter:junit-jupiter:5.10.2'
   testImplementation "org.spockframework:spock-core:2.3-groovy-$groovyVersion"
-  testImplementation 'org.objenesis:objenesis:3.3' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.14.12' // Mocks of classes
+  testImplementation 'org.objenesis:objenesis:3.4' // Mock creation with constructor parameters
+  testImplementation 'net.bytebuddy:byte-buddy:1.14.17' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -83,19 +83,19 @@ dependencies {
   testImplementation "org.testcontainers:couchbase:$testcontainersVersion"
 
   // logging
-  implementation platform('org.apache.logging.log4j:log4j-bom:2.23.0')
+  implementation platform('org.apache.logging.log4j:log4j-bom:2.23.1')
   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.5.3'
-  runtimeOnly 'org.postgresql:postgresql:42.7.2' // postgresql jdbc driver required during runtime
+  implementation 'com.couchbase.client:java-client:3.7.0'
+  runtimeOnly 'org.postgresql:postgresql:42.7.3' // postgresql jdbc driver required during runtime
 
-  implementation 'commons-io:commons-io:2.15.1' // I/O functionalities
-  implementation 'commons-codec:commons-codec:1.16.1' // needed by commons-compress
-  implementation 'org.apache.commons:commons-compress:1.26.0' // I/O functionalities
+  implementation 'commons-io:commons-io:2.16.1' // I/O functionalities
+  implementation 'commons-codec:commons-codec:1.17.0' // needed by commons-compress
+  implementation 'org.apache.commons:commons-compress:1.26.2' // I/O functionalities
 }
 
 tasks.withType(JavaCompile) {

docs/readthedocs/conf.py

@@ -22,8 +22,8 @@
 author = 'Institute of Energy Systems, Energy Efficiency and Energy Economics'
 
 # The full version, including alpha/beta/rc tags
-version = '3.0'
-release = '3.0.0'
+version = '5.0'
+release = '5.0.1'
 
 pygments_style = 'tango'
 add_function_parentheses = True

docs/readthedocs/gettingstarted.md

@@ -20,7 +20,7 @@ On [Maven central](https://search.maven.org/artifact/com.github.ie3-institute/Po
 <dependency>
   <groupId>com.github.ie3-institute</groupId>
   <artifactId>PowerSystemDataModel</artifactId>
-  <version>2.1.0</version>
+  <version>5.0.1</version>
 </dependency>
 ```
 
@@ -41,7 +41,7 @@ and add the dependency:
 <dependency>
   <groupId>com.github.ie3-institute</groupId>
   <artifactId>PowerSystemDataModel</artifactId>
-  <version>3.0-SNAPSHOT</version>
+  <version>6.0-SNAPSHOT</version>
 </dependency>
 ```
 

docs/readthedocs/io/ValidationUtils.md

@@ -11,6 +11,7 @@ The methods in ValidationUtils and subclasses can be used to check that objects
 The general validation checks:
 - if assigned values are valid, e.g. lines are not allowed to have negative lengths or the rated power factor of any unit must be between 0 and 1
 - furthermore, several connections are checked, e.g. that lines only connect nodes of the same voltage level or that the voltage levels indicated for the transformer sides match the voltage levels of the nodes they are connected to.
+- the connectivity of the given grid for all defined operation intervals
 
 The uniqueness validation checks if a collection of given objects are unique in either:
 - a specific field

docs/readthedocs/io/csvfiles.md

@@ -81,6 +81,12 @@ You may extend / alter the naming with pre- or suffix by calling `new EntityPers
 
 ```
 
+### Id Coordinate
+Csv id coordinate sources can have two different ways to represent their coordinate:
+1. ICON: Takes a `latitude` and a `longitude` column
+2. COSMO: Takes a `lat_rot`, a `long_rot`, a `lat_geo` and a `long_geo` column
+
+
 ### Time Series
 
 ```{eval-rst}

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

@@ -7,11 +7,21 @@ coordinates.
 
 ## Information
 
-| Attribute    | Remarks                                                        |
-|:-------------|:---------------------------------------------------------------|
-| `Id`         | An integer value for identifying the coordinate.               |
-| `Coordiante` | Geographical information presented as `Lat/long` of a `Point`. |
+```{eval-rst}
+.. list-table::
+   :widths: 33 33
+   :header-rows: 1
+    
+   * - Attribute
+     - Remarks
+   
+   * - Id
+     - An integer value for identifying the coordinate. 
+   
+   * - Coordinate
+     - Geographical information presented as `Lat/long` of a `Point`.
 
+```
 
 
 ## Known implementations:
@@ -74,19 +84,17 @@ return less than n coordinates.
 
 
 ## Finding and returning the closest corner coordinates:
-In most cases we need four corner coordinates for our given coordinate. Therefor the 
-IdCoordinateSource contains a method that will use the calculated distances to find the closest 
-corner coordinates for the given coordinate.
+In most cases we need four corner coordinates for our given coordinate. Therefor the IdCoordinateSource contains methods
+that tries to return the corner points for a given coordinate. The max. number of corner points is specified by the
+implementation of the second method.
 
 ``` java
-    List<CoordinateDistance> restrictToBoundingBox(
-          Point coordinate,
-          Collection<CoordinateDistance> distances,
-          int numberOfPoints
-    )
+    List<CoordinateDistance> findCornerPoints(Point coordinate, ComparableQuantity<Length> distance)
+    List<CoordinateDistance> findCornerPoints(Point coordinate, Collection<CoordinateDistance> distances)
 ```
 
-For a given set of coordinates, the closest four corner coordinates plus more close points if n > 4
-are returned. If n < 4 the method will return the closest n corner coordinates. If the set of 
-coordinates contains a coordinate that matches the given coordinate, only this one coordinate is
-returned. If n > number of coordinates in the set, all coordinates are returned.
+1. This method can be used to return the corner points by specifying a maximum search distance.
+
+2. If a coordinate matches the given coordinate, only this coordinate is returned. If no coordinate matches the given 
+coordinate, this method tries to return four corner points.
+

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

@@ -17,14 +17,39 @@ In addition to actual data, a mapping function has to be known.
 To be as flexible, as possible, the actual content of the time series is given as children of the `Value` class.
 The following different values are available:
 
-| Value Class            | Purpose                                                                                                       |
-|:-----------------------|:--------------------------------------------------------------------------------------------------------------|
-| `PValue`               | Electrical active power                                                                                       |
-| `SValue`               | Electrical active and reactive power                                                                          |
-| `HeatAndPValue`        | Combination of thermal power (e.g. in kW) <br> and electrical active power (e.g. in kW)                       |
-| `HeatAndSValue`        | Combination of thermal power (e.g. in kW) <br> and electrical active and reactive power (e.g. in kW and kVAr) |
-| `EnergyPriceValue`     | Wholesale market price (e.g. in € / MWh)                                                                      |
-| `SolarIrradianceValue` | Combination of diffuse and direct solar irradiance                                                            |
-| `TemperatureValue`     | Temperature information                                                                                       |
-| `WindValue`            | Combination of wind direction and wind velocity                                                               |
-| `WeatherValue`         | Combination of irradiance, temperature and wind information                                                   |
+```{eval-rst}
+.. list-table::
+   :widths: 33 33
+   :header-rows: 1
+   
+   * - Value Class 
+     - Purpose
+   
+   * - `PValue`
+     - Electrical active power
+   
+   * - `SValue`
+     - Electrical active and reactive power
+     
+   * - `HeatAndPValue`
+     - Combination of thermal power (e.g. in kW) <br> and electrical active power (e.g. in kW)
+     
+   * - `HeatAndSValue`
+     -  Combination of thermal power (e.g. in kW) <br> and electrical active and reactive power (e.g. in kW and kVAr)
+     
+   * - `EnergyPriceValue`
+     - Wholesale market price (e.g. in € / MWh)
+      
+   * - `SolarIrradianceValue`
+     - Combination of diffuse and direct solar irradiance
+     
+   * - `TemperatureValue`
+     - Temperature information
+     
+   * - `WindValue`
+     - Combination of wind direction and wind velocity
+        
+   * - `WeatherValue`
+     - Combination of irradiance, temperature and wind information
+           
+```

docs/readthedocs/models/input/em.md

@@ -10,7 +10,7 @@ Participants are connected to an EM each via their `em` field.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

docs/readthedocs/models/input/grid/gridcontainer.md

@@ -40,7 +40,7 @@ A synoptic overview of both classes' attributes is given here:
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

docs/readthedocs/models/input/grid/line.md

@@ -9,7 +9,7 @@ Representation of an AC line.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
    * - Attribute
      - Unit
@@ -29,15 +29,15 @@ Representation of an AC line.
 
    * - x
      - Ω / km
-     - Phase resistance per length
+     - Phase reactance per length
 
    * - g
      - µS / km
      - Phase-to-ground conductance per length
 
    * - b
      - µS / km
-     - Phase-to-ground conductance per length
+     - Phase-to-ground susceptance per length
 
    * - iMax
      - A
@@ -56,7 +56,7 @@ A list with some standard line types can be found here: [Standard Line Types](#s
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute
@@ -129,7 +129,7 @@ Some standard overhead lines.
 ```{eval-rst}
 .. list-table::
    :widths: 11 11 11 11 11 11 11 11 11
-   :header-rows: 0
+   :header-rows: 1
    
    
    * - uuid
@@ -312,7 +312,7 @@ Some standard cables.
 ```{eval-rst}
 .. list-table::
    :widths: 11 11 11 11 11 11 11 11 11
-   :header-rows: 0
+   :header-rows: 1
    
    
    * - uuid

docs/readthedocs/models/input/grid/linegraphic.md

@@ -9,7 +9,7 @@ Schematic drawing information for a line model.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

docs/readthedocs/models/input/grid/measurementunit.md

@@ -11,7 +11,7 @@ The measured information are indicated by boolean fields.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

docs/readthedocs/models/input/grid/node.md

@@ -9,7 +9,7 @@ Representation of an electrical node, with no further distinction into bus bar,
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

docs/readthedocs/models/input/grid/nodegraphic.md

@@ -9,7 +9,7 @@ Schematic drawing information for a node model.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute