Merge branch 'master' into ck/#12-coverage4scala

Author: ckittl

README.md

@@ -6,7 +6,7 @@
 
 [![simbench logo](https://simbench.de/wp-content/uploads/2019/01/logo.png  "SimBench Logo")](https://www.simbench.net)
 
-Tool to convert SimBench data sets to ie³'s power system data model (to be published in near future).
+Tool to convert SimBench data sets to ie³'s [power system data model](https://github.com/ie3-institute/PowerSystemDataModel).
 SimBench has been research project of Kassel university, Fraunhofer IEE, RWTH Aachen university and TU Dortmund university, aiming at provision of realistic models of electrical distribution grids including time series.
 The data is availabe at https://simbench.de.
 

docs/SimbenchDataModel.puml

@@ -0,0 +1,342 @@
+@startuml
+
+Interface SimbenchModel {
+    + id: String
+}
+
+Interface EntityModel {
+    - subnet: String
+    - voltLvl: Int
+}
+SimbenchModel <|-- EntityModel
+
+Class Coordinate {
+    + x: BigDecimal
+    + y: BigDecimal
+    + subnet: String
+    + voltLvl: Int
+}
+EntityModel <|-- Coordinate
+
+Class Node {
+    + nodeType: NodeType
+    + vmSetp: BigDecimal
+    + vaSetp: Option[BigDecimal] = None
+    + vmR: BigDecimal
+    + vmMin: BigDecimal
+    + vmMax: BigDecimal
+    + substation: Substation
+    + coordinate: Coordinate
+}
+EntityModel <|-- Node
+
+Abstract Class ExternalNet{
+  + calculationType: CalculationType
+  + dspf: BigDecimal
+  + pExt: BigDecimal
+  + qExt: BigDecimal
+}
+EntityModel <|-- ExternalNet
+
+Class Simple{
+    + node: Node
+    + calculationType: CalculationType
+    + dspf: BigDecimal
+    + pExt: BigDecimal
+    + qExt: BigDecimal
+}
+ExternalNet <|-- Simple
+
+Class Ward {
+    + node: Node
+    + dspf: BigDecimal
+    + pExt: BigDecimal
+    + qExt: BigDecimal
+    + pWard: BigDecimal
+    + qWard: BigDecimal
+}
+ExternalNet <|-- Ward
+
+Class WardExtended {
+    + node: Node
+    + dspf: BigDecimal
+    + pExt: BigDecimal
+    + qExt: BigDecimal
+    + rWardExtended: BigDecimal
+    + xWardExtended: BigDecimal
+    + vmWardExtended: BigDecimal
+}
+ExternalNet <|-- WardExtended
+
+Abstract Class Line {
+  + nodeA: Node
+  + nodeB: Node
+  + lineType: T
+  + length: BigDecimal
+  + loadingMax: BigDecimal
+}
+EntityModel <|-- Line
+
+Class ACLine {
+    + lineType: ACLineType
+}
+Line <|-- ACLine
+
+Class DCLine {
+    + lineType: DCLineType
+}
+Line <|-- DCLine
+
+Class Measurement {
+    + elements: List[EntityModel]
+    + variable: MeasurementVariable
+}
+EntityModel <|-- Measurement
+
+Class Substation {
+}
+EntityModel <|-- Substation
+
+Class Switch {
+    + nodeA: Node
+    + nodeB: Node
+    + switchType: SwitchType
+    + cond: Boolean
+    + substation: Substation
+}
+EntityModel <|-- Switch
+
+Class Transformer2W {
+    + nodeHV: Node
+    + nodeLV: Node
+    + transformerType: Transformer2WType
+    + tappos: Int
+    + autoTap: Boolean
+    + autoTapSide: BranchElementPort
+    + loadingMax: BigDecimal
+    + substation: Substation
+}
+EntityModel <|-- Transformer2W
+
+Class Transformer3W {
+    + nodeHV: Node
+    + nodeMV: Node
+    + nodeLV: Node
+    + transformerType: Transformer3WType
+    + tapPosHV: Int
+    + tapPosMV: Int
+    + tapPosLV: Int
+    + autoTap: Boolean
+    + autoTapSide: BranchElementPort
+    + loadingMax: BigDecimal
+    + substation: Substation
+}
+EntityModel <|-- Transformer3W
+
+Interface ShuntModel {
+    - node: Node
+}
+SimbenchModel <|-- ShuntModel
+
+Class Load {
+    + profile: LoadProfileType
+    + pLoad: BigDecimal
+    + qLoad: BigDecimal
+    + sR: BigDecimal
+}
+ShuntModel <|-- Load
+
+Class PowerPlant {
+    + powerPlantType: PowerPlantType
+    + profile: PowerPlantProfileType
+    + calculationType: CalculationType
+    + dspf: BigDecimal
+    + p: BigDecimal
+    + q: BigDecimal
+    + sR: BigDecimal
+    + pMin: BigDecimal
+    + pMax: BigDecimal
+    + qMin: BigDecimal
+    + qMax: BigDecimal
+}
+ShuntModel <|-- PowerPlant
+
+Class RES {
+    + resType: ResType
+    + profile: ResProfile
+    + calculationType: CalculationType
+    + p: BigDecimal
+    + q: BigDecimal
+    + sR: BigDecimal
+}
+ShuntModel <|-- RES
+
+Class Shunt {
+    + p0: BigDecimal
+    + q0: BigDecimal
+    + vmR: BigDecimal
+    + step: Int
+}
+ShuntModel <|-- Shunt
+
+Class Storage {
+    + storageType: StorageType
+    + profile: StorageProfile
+    + p: BigDecimal
+    + q: BigDecimal
+    + soc: BigDecimal
+    + sR: BigDecimal
+    + eStore: BigDecimal
+    + etaStore: BigDecimal
+    + selfDischarge: BigDecimal
+    + pMin: BigDecimal
+    + pMax: BigDecimal
+    + qMin: BigDecimal
+    + qMax: BigDecimal
+}
+ShuntModel <|-- Storage
+
+Class StudyCase {
+    + pLoad: BigDecimal
+    + qLoad: BigDecimal
+    + pWind: BigDecimal
+    + pPv: BigDecimal
+    + pRes: BigDecimal
+    + vMSlack: BigDecimal
+}
+SimbenchModel <|-- StudyCase
+
+Abstract Class LineType
+
+Class ACLineType {
+    + id: String
+    + r: BigDecimal
+    + x: BigDecimal
+    + b: BigDecimal
+    + iMax: BigDecimal
+    + style: LineStyle
+}
+LineType <|-- ACLineType
+ACLine --* ACLineType
+
+Class DCLineType {
+    + id: String
+    + p: BigDecimal
+    + relPLoss: BigDecimal
+    + fixPLoss: BigDecimal
+    + pMax: BigDecimal
+    + qMinA: BigDecimal
+    + qMaxA: BigDecimal
+    + qMinB: BigDecimal
+    + qMaxB: BigDecimal
+}
+LineType <|-- DCLineType
+DCLine --* DCLineType
+
+Class Transformer2WType {
+    + sR: BigDecimal
+    + vmHV: BigDecimal
+    + vmLV: BigDecimal
+    + va0: BigDecimal
+    + vmImp: BigDecimal
+    + pCu: BigDecimal
+    + pFe: BigDecimal
+    + iNoLoad: BigDecimal
+    + tapable: Boolean
+    + tapside: BranchElementPort
+    + dVm: BigDecimal
+    + dVa: BigDecimal
+    + tapNeutr: Int
+    + tapMin: Int
+    + tapMax: Int
+}
+SimbenchModel <|-- Transformer2WType
+Transformer2W --* Transformer2WType
+
+Class Transformer3WType {
+    + sRHV: BigDecimal
+    + sRMV: BigDecimal
+    + sRLV: BigDecimal
+    + vmHV: BigDecimal
+    + vmMV: BigDecimal
+    + vmLV: BigDecimal
+    + vaHVMV: BigDecimal
+    + vaHVLV: BigDecimal
+    + vmImpHV: BigDecimal
+    + vmImpMV: BigDecimal
+    + vmImpLV: BigDecimal
+    + pCuHV: BigDecimal
+    + pCuMV: BigDecimal
+    + pCuLV: BigDecimal
+    + pFe: BigDecimal
+    + iNoLoad: BigDecimal
+    + tapable: Boolean
+    + tapSide: BranchElementPort
+    + dVmHV: BigDecimal
+    + dVmMV: BigDecimal
+    + dVmLV: BigDecimal
+    + dVaHV: BigDecimal
+    + dVaMV: BigDecimal
+    + dVaLV: BigDecimal
+    + tapNeutrHV: Int
+    + tapNeutrMV: Int
+    + tapNeutrLV: Int
+    + tapMinHV: Int
+    + tapMinMV: Int
+    + tapMinLV: Int
+    + tapMaxHV: Int
+    + tapMaxMV: Int
+    + tapMaxLV: Int
+}
+SimbenchModel <|-- Transformer3WType
+Transformer3W --* Transformer3WType
+
+Interface ProfileType {
+}
+
+Enum LoadProfileType {
+    + apply(String): LoadProfileType
+}
+ProfileType <|-- LoadProfileType
+
+Enum PowerPlantProfileType {
+    + apply(String): PowerPlantProfileType
+}
+ProfileType <|-- PowerPlantProfileType
+
+Enum ResProfileType {
+    + apply(String): ResProfileType
+}
+ProfileType <|-- ResProfileType
+
+Interface StorageProfileType {
+}
+ProfileType <|-- StorageProfileType
+
+Interface ProfileModel <T extends ProfileType> {
+    + profileType: T
+    + profile: Map<ZonedDateTime, Tuple2<BigDecimal, BigDecimal>>
+}
+SimbenchModel <|-- ProfileModel
+
+Class LoadProfile {
+}
+ProfileModel <|-- LoadProfile
+LoadProfileType *-- LoadProfile
+
+Class PowerPlantProfile {
+}
+ProfileModel <|-- PowerPlantProfile
+PowerPlantProfileType *-- PowerPlantProfile
+
+Class ResProfile {
+}
+ProfileModel <|-- ResProfile
+ResProfileType *-- ResProfile
+
+Class StorageProfile {
+}
+ProfileModel <|-- StorageProfile
+StorageProfileType *-- StorageProfile
+
+@enduml

inputData/config/SimbenchSample.conf

@@ -3,9 +3,21 @@ io {
   ## 'baseUrl': optional string. Default: http://141.51.193.167/simbench/gui/usecase/download.
   #baseUrl = ?
 
+  ## 'csv': required section.
+  csv {
+    ## 'fileEncoding': optional string. Default: UTF-8.
+    #fileEncoding = ?
+    
+    ## 'fileEnding': optional string. Default: .csv.
+    #fileEnding = ?
+    
+    ## 'separator': optional string. Default: ;.
+    #separator = ?
+  }
+  
   ## 'downloadFolder': optional string. Default: inputData/download/.
   #downloadFolder = ?
 
   ## 'simbenchCodes': required list of string.
-  simbenchCodes = ["1-EHVHVMVLV-mixed-all-0-sw", "1-EHVHVMVLV-mixed-all-1-sw"]
+  simbenchCodes = [string, ...]
 }

src/main/resources/config-template.conf

@@ -1,3 +1,6 @@
 io.simbenchCodes = ["String"]
 io.downloadFolder = "String" | "inputData/download/"
-io.baseUrl = "String" | "http://141.51.193.167/simbench/gui/usecase/download"
+io.baseUrl = "String" | "http://141.51.193.167/simbench/gui/usecase/download"
+io.csv.separator = "String" | ";"
+io.csv.fileEnding = "String" | ".csv"
+io.csv.fileEncoding = "String" | "UTF-8"