Merge branch 'dev' into ms/#827-use-java-streams-on-sql-fetsches-effe…

…ctively
ie3-institute · May 1, 2024 · f01cbbd · f01cbbd
2 parents b3c6db7 + 2ec2f79
commit f01cbbd
Show file tree

Hide file tree

Showing 64 changed files with 336 additions and 167 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+- Enhancing `VoltageLevel` with `equals` method [#1063](https://github.com/ie3-institute/PowerSystemDataModel/issues/1063)
+
+### Fixed
+
+### Changed
+- Improvements to the search for corner points in `IdCoordinateSource` [#1016](https://github.com/ie3-institute/PowerSystemDataModel/issues/1016)
+
+
 ## [5.0.1] - 2024-03-07
 
 ### Fixed
@@ -23,7 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added test for invalid input data in `CsvRawGridSource` [#1021](https://github.com/ie3-institute/PowerSystemDataModel/issues/1021)
 - Added `CsvThermalGridSource` [#1009](https://github.com/ie3-institute/PowerSystemDataModel/issues/1009)
 - Enhance documentation for CSV timeseries [#825](https://github.com/ie3-institute/PowerSystemDataModel/issues/825)
-- Enhancing `VoltageLevel` with `equals` method [#1063](https://github.com/ie3-institute/PowerSystemDataModel/issues/1063)
 
 ### Fixed
 - Fixed Couchbase integration tests that randomly failed [#755](https://github.com/ie3-institute/PowerSystemDataModel/issues/755)

diff --git a/docs/readthedocs/conf.py b/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

diff --git a/docs/readthedocs/gettingstarted.md b/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>
 ```
 

diff --git a/docs/readthedocs/io/csvfiles.md b/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}

diff --git a/docs/readthedocs/models/input/additionaldata/idcoordinatesource.md b/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.
+
diff --git a/docs/readthedocs/models/input/additionaldata/timeseries.md b/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
+           
+```
diff --git a/docs/readthedocs/models/input/em.md b/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

diff --git a/docs/readthedocs/models/input/grid/gridcontainer.md b/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

diff --git a/docs/readthedocs/models/input/grid/line.md b/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
@@ -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

diff --git a/docs/readthedocs/models/input/grid/linegraphic.md b/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

diff --git a/docs/readthedocs/models/input/grid/measurementunit.md b/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

diff --git a/docs/readthedocs/models/input/grid/node.md b/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

diff --git a/docs/readthedocs/models/input/grid/nodegraphic.md b/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

diff --git a/docs/readthedocs/models/input/grid/switch.md b/docs/readthedocs/models/input/grid/switch.md
@@ -9,7 +9,7 @@ Model of an ideal switch connecting two node models of the same voltage level
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

diff --git a/docs/readthedocs/models/input/grid/transformer2w.md b/docs/readthedocs/models/input/grid/transformer2w.md
@@ -13,7 +13,7 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
    * - Attribute
      - Unit
@@ -85,7 +85,7 @@ A list with some standard transformer types can be found here: [Standard Two Win
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
    * - Attribute
      - Unit
@@ -145,7 +145,7 @@ The transformers which source is ``simBench`` are from [here](https://simbench.d
 ```{eval-rst}
 .. list-table::
    :widths: 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6
-   :header-rows: 0
+   :header-rows: 1
    
    * - uuid
      - bM

diff --git a/docs/readthedocs/models/input/grid/transformer3w.md b/docs/readthedocs/models/input/grid/transformer3w.md
@@ -25,7 +25,7 @@ All impedances and admittances are given with respect to the higher voltage side
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute
@@ -123,7 +123,7 @@ All impedances and admittances are given with respect to the higher voltage side
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

diff --git a/docs/readthedocs/models/input/operator.md b/docs/readthedocs/models/input/operator.md
@@ -10,7 +10,7 @@ having control over one or more physical entitites.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

diff --git a/docs/readthedocs/models/input/participant/bm.md b/docs/readthedocs/models/input/participant/bm.md
@@ -11,7 +11,7 @@ Model of a biomass power plant.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute
@@ -58,7 +58,7 @@ Model of a biomass power plant.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

diff --git a/docs/readthedocs/models/input/participant/chp.md b/docs/readthedocs/models/input/participant/chp.md
@@ -11,7 +11,7 @@ Combined heat and power plant.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute
@@ -66,7 +66,7 @@ Combined heat and power plant.
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute

diff --git a/docs/readthedocs/models/input/participant/ev.md b/docs/readthedocs/models/input/participant/ev.md
@@ -11,7 +11,7 @@ Model of an electric vehicle, that is occasionally connected to the grid via an
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute
@@ -62,7 +62,7 @@ Model of an electric vehicle, that is occasionally connected to the grid via an
 ```{eval-rst}
 .. list-table::
    :widths: 33 33 33
-   :header-rows: 0
+   :header-rows: 1
 
 
    * - Attribute