Merge branch 'dev' into rel/sp/#730-release-3.0

Author: sebastian-peter

.github/dependabot.yml

@@ -12,7 +12,16 @@ updates:
   - sensarmad
   - sebastian-peter
   - danielfeismann
+  - jo-bao
   ignore:
   - dependency-name: org.spockframework:spock-core
     versions:
         - 2.3-groovy-4.0
+
+- package-ecosystem: pip
+  directory: "/docs/readthedocs"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 8
+  target-branch: dev

CHANGELOG.md

@@ -19,6 +19,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `ThermalGrid` as a container for a completely connected thermal grid
 - `EmResult` and `FlexOptionsResult` for Energy Management Systems [#651](https://github.com/ie3-institute/PowerSystemDataModel/issues/651)
 - `EvcsInput` now has a parameter for enabling and disabling vehicle to grid support [#681](https://github.com/ie3-institute/PowerSystemDataModel/issues/681)
+- Added Dependabot updates to sphinx/readthedocs dependencies [#735](https://github.com/ie3-institute/PowerSystemDataModel/issues/735)
+- Created convenience function for JointGridContainer from CSV [#502](https://github.com/ie3-institute/PowerSystemDataModel/issues/502)
+- Added CSV grid IO integration test [#586](https://github.com/ie3-institute/PowerSystemDataModel/issues/586)
 
 ### Fixed
 - Reduced code smells [#492](https://github.com/ie3-institute/PowerSystemDataModel/issues/492)

build.gradle

@@ -4,9 +4,9 @@ plugins {
   id 'maven-publish'
   id 'signing'
   id 'pmd' // code check, working on source code
-  id 'com.diffplug.spotless' version '6.14.0'//code format
+  id 'com.diffplug.spotless' version '6.15.0'//code format
   id 'com.github.spotbugs' version '5.0.13' // code check, working on byte code
-  id 'de.undercouch.download' version '5.3.0'
+  id 'de.undercouch.download' version '5.3.1'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
   id "org.sonarqube" version "3.5.0.2730" // sonarqube
@@ -67,7 +67,7 @@ dependencies {
   testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
   testImplementation 'org.spockframework:spock-core:2.3-groovy-3.0'
   testImplementation 'org.objenesis:objenesis:3.3' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.12.22' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.13.0' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -84,8 +84,8 @@ dependencies {
 
   // Databases
   implementation 'org.influxdb:influxdb-java:2.23'
-  implementation 'com.couchbase.client:java-client:3.4.2'
-  runtimeOnly 'org.postgresql:postgresql:42.5.1' // postgresql jdbc driver required during runtime
+  implementation 'com.couchbase.client:java-client:3.4.3'
+  runtimeOnly 'org.postgresql:postgresql:42.5.3' // postgresql jdbc driver required during runtime
 
   implementation 'commons-io:commons-io:2.11.0' // I/O functionalities
   implementation 'org.apache.commons:commons-compress:1.22' // I/O functionalities

docs/readthedocs/index.rst

@@ -19,8 +19,11 @@ Contact the (Main) Maintainers
 If you feel, something this missing, wrong or misleading, please contact one of our main contributors:
 
    * `@sensarmad <https://github.com/sensarmad>`_
-   * `@johanneshiry <https://github.com/johanneshiry>`_
-   * `@ckittl <https://github.com/ckittl>`_
+   * `@t-ober <https://github.com/t-ober>`_
+   * `@danielfeismann <https://github.com/danielfeismann>`_
+   * `@sebastian-peter <https://github.com/sebastian-peter>`_
+   * `@jo-bao <https://github.com/jo-bao>`_
+   * `@julianhohmann <https://github.com/julianhohmann>`_
 
 Hat tip to all other contributors!
 

docs/readthedocs/models/models.rst

@@ -24,7 +24,7 @@ Immutability
 Copyable
   With the general design principle of immutability, entity modifications (e.g. updates of field values) can become
   hard and annoying. To avoid generating methods to update each field value, we provide an adapted version of the
-  `builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`_ to make entity modifications as easy as possible.
+  `builder pattern <https://en.wikipedia.org/wiki/Builder_pattern/>`__ to make entity modifications as easy as possible.
   Each entity holds it's own copy builder class, which follows the same inheritance as the entity class itself. With a
   call of `.copy()` on an entity instance a builder instance is returned, that allows for modification of fields and
   can be terminated with `.build()` which will return an instance of the entity with modified field values as required.
@@ -50,7 +50,7 @@ Harmonized Units System
 
 Equality Checks
   To represent quantities in the models within an acceptable accuracy, the JSR 385 reference implementation
-  `Indriya <https://github.com/unitsofmeasurement/indriya>`_ is used. Comparing quantity objects or objects holding quantity
+  `Indriya <https://github.com/unitsofmeasurement/indriya>`__ is used. Comparing quantity objects or objects holding quantity
   instances is not as trivial as it might seem, because there might be different understandings about the equality of
   quantities (e.g. there is a big difference between two instances being equal or equivalent). After long discussions how to
   treat quantities in the entity :code:`equals()` method, we agreed on the following rules to be applied:
@@ -74,12 +74,12 @@ Equality Checks
     would return :code:`false` as the equality check does NOT convert units. If you want to compare two entity instances
     based on their equivalence you have (for now) check for each quantity manually using their :code:`isEquivalentTo()`
     method. If you think you would benefit from a standard method that allows entity equivalence check, please consider
-    handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`_.
+    handing in an issue `here <https://github.com/ie3-institute/PowerSystemDataModel/issues>`__.
     Furthermore, the current existing implementation of :code:`isEquivalentTo()` in indriya does not allow the provision of
     a tolerance threshold that might be necessary when comparing values from floating point operations. We consider
-    providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`_ library.
+    providing such a method in our `PowerSystemUtils <https://github.com/ie3-institute/PowerSystemUtils>`__ library.
     If you think you would benefit from such a method, please consider handing in an issue
-    `here <https://github.com/ie3-institute/PowerSystemUtils/issues>`_.
+    `here <https://github.com/ie3-institute/PowerSystemUtils/issues>`__.
 
 Conditional Parameters
   Some of the models have conditional parameters. When reading model data from a data source, their respective factories for building these 
@@ -97,8 +97,8 @@ Model classes you can use to describe a data set as input to power system simula
 
    input/operator
 
-Grid Related Models
-===================
+Grid Related Input Models
+=========================
 .. toctree::
    :maxdepth: 1
 
@@ -112,8 +112,8 @@ Grid Related Models
    input/grid/measurementunit
    input/grid/gridcontainer
 
-Participant Related Models
-==========================
+Participant Related Input Models
+================================
 .. toctree::
    :maxdepth: 1
 
@@ -137,8 +137,8 @@ Result
 ******
 Model classes you can use to describe the outcome of a power system simulation.
 
-Grid Related Models
-===================
+Grid Related Result Models
+==========================
 .. toctree::
    :maxdepth: 1
 
@@ -150,8 +150,8 @@ Grid Related Models
    result/grid/transformer2w
    result/grid/transformer3w
 
-Participant Related Models
-==========================
+Participant Related Result Models
+=================================
 .. toctree::
    :maxdepth: 1
 

docs/readthedocs/requirements.txt

@@ -1,4 +1,4 @@
 commonmark==0.9.1
 recommonmark==0.7.1
-Sphinx==4.2.0
-sphinx-rtd-theme==1.0.0
+Sphinx==5.3.0
+sphinx-rtd-theme==1.2.0

src/main/java/edu/ie3/datamodel/io/source/csv/CsvJointGridContainerSource.java

@@ -0,0 +1,56 @@
+/*
+ * © 2022. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.source.csv;
+
+import edu.ie3.datamodel.exceptions.SourceException;
+import edu.ie3.datamodel.io.naming.FileNamingStrategy;
+import edu.ie3.datamodel.io.source.*;
+import edu.ie3.datamodel.models.input.container.GraphicElements;
+import edu.ie3.datamodel.models.input.container.JointGridContainer;
+import edu.ie3.datamodel.models.input.container.RawGridElements;
+import edu.ie3.datamodel.models.input.container.SystemParticipants;
+
+/** Convenience class for cases where all used data comes from CSV sources */
+public class CsvJointGridContainerSource {
+  private CsvJointGridContainerSource() {}
+
+  public static JointGridContainer read(String gridName, String csvSep, String directoryPath)
+      throws SourceException {
+
+    /* Parameterization */
+
+    FileNamingStrategy namingStrategy = new FileNamingStrategy(); // Default naming strategy
+
+    /* Instantiating sources */
+    TypeSource typeSource = new CsvTypeSource(csvSep, directoryPath, namingStrategy);
+    RawGridSource rawGridSource =
+        new CsvRawGridSource(csvSep, directoryPath, namingStrategy, typeSource);
+    ThermalSource thermalSource =
+        new CsvThermalSource(csvSep, directoryPath, namingStrategy, typeSource);
+    SystemParticipantSource systemParticipantSource =
+        new CsvSystemParticipantSource(
+            csvSep, directoryPath, namingStrategy, typeSource, thermalSource, rawGridSource);
+    GraphicSource graphicsSource =
+        new CsvGraphicSource(csvSep, directoryPath, namingStrategy, typeSource, rawGridSource);
+
+    /* Loading models */
+    RawGridElements rawGridElements =
+        rawGridSource
+            .getGridData()
+            .orElseThrow(() -> new SourceException("Error during reading of raw grid data."));
+    SystemParticipants systemParticipants =
+        systemParticipantSource
+            .getSystemParticipants()
+            .orElseThrow(
+                () -> new SourceException("Error during reading of system participant data."));
+    GraphicElements graphicElements =
+        graphicsSource
+            .getGraphicElements()
+            .orElseThrow(() -> new SourceException("Error during reading of graphic elements."));
+
+    return new JointGridContainer(gridName, rawGridElements, systemParticipants, graphicElements);
+  }
+}

src/test/groovy/edu/ie3/datamodel/io/connectors/CsvFileConnectorTest.groovy

@@ -62,8 +62,8 @@ class CsvFileConnectorTest extends Specification {
   }
 
   def cleanupSpec() {
-    FileIOUtils.deleteRecursively(tmpDirectory)
     cfc.shutdown()
+    FileIOUtils.deleteRecursively(tmpDirectory)
   }
 
   def "The csv file connector is able to provide correct paths to time series files"() {

src/test/groovy/edu/ie3/datamodel/io/csv/GridIoIT.groovy

@@ -0,0 +1,60 @@
+/*
+ * © 2022. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+package edu.ie3.datamodel.io.csv
+
+import edu.ie3.datamodel.io.sink.CsvFileSink
+import edu.ie3.datamodel.io.source.csv.CsvJointGridContainerSource
+import edu.ie3.datamodel.io.source.csv.CsvTestDataMeta
+import edu.ie3.util.io.FileIOUtils
+import spock.lang.Shared
+import spock.lang.Specification
+
+import java.nio.file.Files
+import java.nio.file.Path
+
+/**
+ * Testing whether PSDM CSV grids are equal when serialized and deserialized sequentially.
+ * Grid data should <strong>not</strong> change when written out or parsed.
+ */
+class GridIoIT extends Specification implements CsvTestDataMeta {
+
+  @Shared
+  Path tempDirectory
+
+  @Shared
+  CsvFileSink sink
+
+  def setupSpec() {
+    tempDirectory = Files.createTempDirectory("GridIoIT")
+    sink = new CsvFileSink(tempDirectory.toAbsolutePath().toString())
+  }
+
+  def cleanupSpec() {
+    sink.shutdown()
+    FileIOUtils.deleteRecursively(tempDirectory)
+  }
+
+  def "Input JointGridContainer equals Output JointGridContainer."() {
+
+    given:
+    // create joint grid container
+    def gridName = "vn_simona"
+    def separator = ","
+    def firstGridContainer = CsvJointGridContainerSource.read(gridName, separator, jointGridFolderPath)
+
+    when:
+    // write files from joint grid container in output directory
+    sink.persistJointGrid(firstGridContainer)
+
+    // create second grid container from output folder
+    def secondGridContainer = CsvJointGridContainerSource.read(gridName, separator, tempDirectory.toAbsolutePath().toString())
+
+    then:
+    // compare input and output joint grid container
+    firstGridContainer == secondGridContainer
+
+  }
+}

src/test/groovy/edu/ie3/datamodel/io/source/csv/CsvTestDataMeta.groovy

@@ -24,6 +24,7 @@ trait CsvTestDataMeta {
   static String coordinatesCosmoFolderPath = getResourceAbs("_coordinates/cosmo")
   static String weatherCosmoFolderPath = getResourceAbs("_weather/cosmo")
   static String weatherIconFolderPath = getResourceAbs("_weather/icon")
+  static String jointGridFolderPath = getResourceAbs("_joint_grid")
 
   static String gridDefaultFolderPath = getResourceAbs("_grid/default")
   static String gridMalformedFolderPath = getResourceAbs("_grid/malformed")