To/#181 reduced grid model

.gitignore

@@ -175,7 +175,6 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-
 # End of https://www.toptal.com/developers/gitignore/api/python
 
 # Ignore Gradle project-specific cache directory

build.gradle

@@ -94,6 +94,7 @@ dependencies {
 	scalaCompilerPlugin "com.sksamuel.scapegoat:scalac-scapegoat-plugin_${scalaBinaryVersion}:1.4.11" // scala scapegoat
 
 	implementation 'tech.units:indriya:2.1.3-SNAPSHOT'
+	implementation 'com.opencsv:opencsv:5.5.2'
 }
 
 /* scapegoat hook configuration

src/main/scala/edu/ie3/powerFactory2psdm/converter/GridConverter.scala

@@ -155,6 +155,5 @@ case object GridConverter {
       Set.empty[StorageInput].asJava,
       statGenModelContainer.wecInputs.toSet.asJava
     )
-
   }
 }

src/main/scala/edu/ie3/powerFactory2psdm/io/IoUtils.scala

@@ -0,0 +1,200 @@
+/*
+ * © 2021. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+ */
+
+package edu.ie3.powerFactory2psdm.io
+
+import com.opencsv.{CSVWriter, ICSVWriter}
+import com.typesafe.scalalogging.LazyLogging
+import edu.ie3.datamodel.exceptions.SourceException
+import edu.ie3.datamodel.io.naming.{
+  DefaultDirectoryHierarchy,
+  EntityPersistenceNamingStrategy,
+  FileNamingStrategy
+}
+import edu.ie3.datamodel.io.sink.CsvFileSink
+import edu.ie3.datamodel.io.source.csv.{
+  CsvGraphicSource,
+  CsvRawGridSource,
+  CsvTypeSource
+}
+import edu.ie3.powerFactory2psdm.model.RawPfGridModel
+import io.circe.parser.decode
+import io.circe.generic.auto._
+import edu.ie3.datamodel.io.source.csv.CsvSystemParticipantSource
+import edu.ie3.datamodel.io.source.csv.CsvThermalSource
+import edu.ie3.datamodel.models.input.container.JointGridContainer
+
+import scala.io.Source
+import java.io.{BufferedWriter, FileWriter}
+import scala.jdk.CollectionConverters.IterableHasAsJava
+import scala.util.{Failure, Try}
+import io.circe.parser._
+
+object IoUtils extends LazyLogging {
+
+  /** Reads a json export of a PowerFactory grid and builds a
+    * [[RawPfGridModel]].
+    *
+    * @param gridFile
+    *   path to json export
+    * @return
+    *   a [[RawPfGridModel]] instance
+    */
+  def parsePfGrid(gridFile: String): Option[RawPfGridModel] = {
+    val source =
+      Source.fromFile(gridFile)
+    val jsonString =
+      try source.mkString
+      finally source.close
+
+    decode[RawPfGridModel](jsonString) match {
+      case Left(error) =>
+        logger.error(error.getMessage())
+        None
+      case Right(decodingResult) =>
+        Some(decodingResult)
+    }
+  }
+
+  @deprecated("should be implemented within PSDM")
+  def parsePsdmGrid(
+      gridName: String,
+      csvSep: String,
+      folderPath: String,
+      namingStrategy: FileNamingStrategy
+  ): JointGridContainer = {
+
+    /* Instantiating sources */
+    val typeSource = new CsvTypeSource(csvSep, folderPath, namingStrategy)
+    val rawGridSource =
+      new CsvRawGridSource(csvSep, folderPath, namingStrategy, typeSource)
+
+    val thermalSource =
+      new CsvThermalSource(csvSep, folderPath, namingStrategy, typeSource)
+    val systemParticipantSource = new CsvSystemParticipantSource(
+      csvSep,
+      folderPath,
+      namingStrategy,
+      typeSource,
+      thermalSource,
+      rawGridSource
+    )
+    val graphicsSource = new CsvGraphicSource(
+      csvSep,
+      folderPath,
+      namingStrategy,
+      typeSource,
+      rawGridSource
+    )
+
+    /* Loading models */
+    val rawGridElements = rawGridSource.getGridData.orElseThrow(() =>
+      new SourceException("Error during reading of raw grid data.")
+    )
+    val systemParticipants =
+      systemParticipantSource.getSystemParticipants.orElseThrow(() =>
+        new SourceException("Error during reading of system participant data.")
+      )
+    val graphicElements = graphicsSource.getGraphicElements.orElseThrow(() =>
+      new SourceException("Error during reading of graphic elements.")
+    )
+
+    new JointGridContainer(
+      gridName,
+      rawGridElements,
+      systemParticipants,
+      graphicElements
+    )
+  }
+
+  /** Credits to isomarcte:
+    * https://stackoverflow.com/questions/52666231/how-to-write-to-a-csv-file-in-scala
+    */
+  def writeCsvFile(
+      fileName: String,
+      header: List[String],
+      rows: List[List[String]]
+  ): Try[Unit] =
+    Try(
+      new CSVWriter(
+        new BufferedWriter(new FileWriter(fileName)),
+        ICSVWriter.DEFAULT_SEPARATOR,
+        ICSVWriter.NO_QUOTE_CHARACTER,
+        ICSVWriter.DEFAULT_ESCAPE_CHARACTER,
+        ICSVWriter.DEFAULT_LINE_END
+      )
+    ).flatMap((csvWriter: CSVWriter) =>
+      Try {
+        csvWriter.writeAll(
+          (header +: rows).map(_.toArray).asJava
+        )
+        csvWriter.close()
+      } match {
+        case f @ Failure(_) =>
+          Try(csvWriter.close()).recoverWith { case _ =>
+            f
+          }
+        case success =>
+          success
+      }
+    )
+
+  /** Get either a flat or hierarchic file naming strategy.
+    *
+    * @param usesHierarchicNaming
+    *   whether hierarchic or not
+    * @param baseDirectory
+    *   the base directory for hierarchig file naming strategy
+    * @param gridName
+    *   the name of the grid
+    * @return
+    */
+  def getFileNamingStrategy(
+      usesHierarchicNaming: Boolean,
+      baseDirectory: String,
+      gridName: String
+  ): FileNamingStrategy = {
+    if (usesHierarchicNaming)
+      new FileNamingStrategy(
+        new EntityPersistenceNamingStrategy(),
+        new DefaultDirectoryHierarchy(baseDirectory, gridName)
+      )
+    else new FileNamingStrategy()
+  }
+
+  /** Persist a joint grid container as csv files
+    *
+    * @param jointGridContainer
+    *   the grid to persist
+    * @param gridName
+    *   the grid name
+    * @param usesHierarchicNaming
+    *   whether to use hierarchic naming or not
+    * @param targetDirectory
+    *   the directory where to store the grid
+    * @param csvSeparator
+    *   the csv separator
+    */
+  def persistJointGridContainer(
+      jointGridContainer: JointGridContainer,
+      gridName: String,
+      usesHierarchicNaming: Boolean,
+      targetDirectory: String,
+      csvSeparator: String
+  ): Unit = {
+    val fileNamingStrategy =
+      getFileNamingStrategy(usesHierarchicNaming, targetDirectory, gridName)
+
+    val csvSink = new CsvFileSink(
+      targetDirectory,
+      fileNamingStrategy,
+      false,
+      csvSeparator
+    )
+
+    csvSink.persistJointGrid(jointGridContainer)
+  }
+}

src/main/scala/edu/ie3/powerFactory2psdm/main/RunConversion.scala

@@ -16,10 +16,11 @@ import edu.ie3.datamodel.io.sink.CsvFileSink
 import edu.ie3.powerFactory2psdm.config.ConversionConfig
 import edu.ie3.powerFactory2psdm.config.validate.ConfigValidator
 import edu.ie3.powerFactory2psdm.converter.GridConverter
-import edu.ie3.powerFactory2psdm.io.PfGridParser
+import edu.ie3.powerFactory2psdm.io.IoUtils
 
 import java.io.File
 import edu.ie3.powerFactory2psdm.exception.io.GridParsingException
+import edu.ie3.powerFactory2psdm.io.IoUtils.persistJointGridContainer
 import edu.ie3.powerFactory2psdm.model.RawPfGridModel
 import pureconfig.ConfigSource
 import pureconfig.generic.auto._
@@ -38,34 +39,21 @@ object RunConversion extends LazyLogging {
     val exportedGridFile =
       s"${new File(".").getCanonicalPath}/src/main/python/pfGridExport/pfGrid.json"
     logger.info("Parsing the json grid file.")
-    val pfGrid: RawPfGridModel = PfGridParser
-      .parse(exportedGridFile)
+    val pfGrid: RawPfGridModel = IoUtils
+      .parsePfGrid(exportedGridFile)
       .getOrElse(
         throw GridParsingException("Parsing the Json grid file failed")
       )
     logger.info("Converting grid to PSDM")
     val jointGridContainer = GridConverter.convert(pfGrid, config)
 
-    val baseTargetDirectory = config.output.targetFolder
+    persistJointGridContainer(
+      jointGridContainer,
+      config.gridName,
+      config.output.csvConfig.directoryHierarchy,
+      config.output.targetFolder,
+      config.output.csvConfig.separator
+    )
 
-    val csvSink = if (config.output.csvConfig.directoryHierarchy) {
-      new CsvFileSink(
-        baseTargetDirectory,
-        new FileNamingStrategy(
-          new EntityPersistenceNamingStrategy(),
-          new DefaultDirectoryHierarchy(baseTargetDirectory, config.gridName)
-        ),
-        false,
-        config.output.csvConfig.separator
-      )
-    } else {
-      new CsvFileSink(
-        baseTargetDirectory,
-        new FileNamingStrategy(),
-        false,
-        config.output.csvConfig.separator
-      )
-    }
-    csvSink.persistJointGrid(jointGridContainer)
   }
 }