config-template.conf

#@define
VoltLvlConfig {
  id: string    # identifier of the voltage level
  vNom: string  # nominal voltage, expl.: 10 kV
}

#@define
RefSystemConfig {
  sNom: string                # Nominal power, expl.: 600 kVA
  vNom: string                # Nominal voltage, expl.: 0.4 kV
  #@optional
  voltLvls: [VoltLvlConfig]   # Voltage levels to apply to
  #@optional
  gridIds: [string]           # Sub grid numbers to apply to, expl.: 1,2,4..10
}

#@define abstract extends !java.io.Serializable
BaseRuntimeConfig {
  uuids: [string]          # Unique id to identify the system participant models this config applies for
  scaling: double          # General scaling factor of the system participant model
  calculateMissingReactivePowerWithModel: boolean # When receiving primary data: Fill up with 0 or model func
}

#@define extends BaseRuntimeConfig
LoadRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig
  modelBehaviour: string  # How the model behaves. Possible values: fix, profile, random
  reference: string       # Scaling reference for the load model. Possible values: power, energy
}

#@define extends BaseRuntimeConfig
FixedFeedInRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise FixedFeedInRuntimeConfig is handled as String
}

#@define extends BaseRuntimeConfig
PvRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise PvRuntimeConfig is handled as String
}

#@define extends BaseRuntimeConfig
WecRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise WecRuntimeConfig is handled as String
}

#@define extends BaseRuntimeConfig
EvcsRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise EvcsRuntimeConfig is handled as String
  chargingStrategy: String | "maxPower" # can be one of maxPower, constantPower, gridOrientedScheduling or marketOrientedScheduling
  lowestEvSoc: Double | 0.2 # Defines the lowest possible state of charge (SoC) that an EV is allowed to uncharge in vehicle to grid (V2G) mode
}

#@define extends BaseRuntimeConfig
StorageRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise StorageRuntimeConfig is handled as String
  initialSoc: Double | 0 # Defines initial soc of storages as a share of capacity, 0-1
  #@optional
  targetSoc: Double
}

#@define extends BaseRuntimeConfig
EmRuntimeConfig {
  # # # # #
  # ATTENTION: calculateMissingReactivePowerWithModel and scaling is ignored here.
  # Cleaner solution is possible with different config framework.
  # # # # #
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise EmRuntimeConfig is handled as String
  curtailRegenerative: Boolean | false
  aggregateFlex: String | "SELF_OPT_EXCL_REG"
}

#@define extends BaseRuntimeConfig
HpRuntimeConfig {
  baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
  # but cannot removed bc otherwise HpRuntimeConfig is handled as String
}

#@define abstract
CsvParams {
  directoryPath: "string"
  isHierarchic: "boolean"
  csvSep: "string"
}

#@define extends CsvParams
BaseCsvParams {
  base: CsvParams
}

#@define extends CsvParams
PrimaryDataCsvParams {
  base: CsvParams
  timePattern: string | "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]X" # default pattern from PSDM:TimeBasedSimpleValueFactory
}

#@define abstract
KafkaParams {
  runId: string
  bootstrapServers: string
  schemaRegistryUrl: string
  linger: int // in ms
}

#@define extends KafkaParams
ResultKafkaParams {
  base: KafkaParams
  topicNodeRes = string
}

#@define extends KafkaParams
RuntimeKafkaParams {
  base: KafkaParams
  topic = string
}

#@define abstract
BaseOutputConfig {
  notifier: string           # Result event notifier
  simulationResult: boolean  # Inform listeners about new simulation result
}

#@define extends BaseOutputConfig
SimpleOutputConfig {
  base: BaseOutputConfig
}

#@define extends BaseOutputConfig
ParticipantBaseOutputConfig {
  base: BaseOutputConfig
  powerRequestReply: boolean # Inform listeners about power request replies
  flexResult: boolean | false
}

#@define
GridOutputConfig {
  notifier: string         # Result event notifier
  nodes: boolean | false
  lines: boolean | false
  switches: boolean | false
  transformers2w: boolean | false
  transformers3w: boolean | false
}

#@define
TransformerControlGroup {
  measurements: [string]
  transformers: [string]
  vMax: Double
  vMin: Double
}

##################################################################
# Agentsim
##################################################################
simona.simulationName = "string"
simona.time.startDateTime = "2011-05-01T00:00:00Z"
simona.time.endDateTime = "2011-05-01T01:00:00Z"
#@optional
simona.time.schedulerReadyCheckWindow = int

##################################################################
# Input Parameters
##################################################################
simona.input.primary = {
    #@optional
    csvParams = PrimaryDataCsvParams
    #@optional
    influxDb1xParams = {
      url:  string
      port: Int
      database: string
      timePattern: string | "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]X" # default pattern from PSDM:TimeBasedSimpleValueFactory
    }
    #@optional
    sqlParams = {
      jdbcUrl:  string
      userName: string
      password: string
      schemaName: string | "public"
      timePattern: string | "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]X" # default pattern from PSDM:TimeBasedSimpleValueFactory
    }
    #@optional
    couchbaseParams = {
      url:  string
      bucketName:  string
      userName: string
      password: string
      coordinateColumnName: string
      keyPrefix: string
      timePattern: string | "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]X" # default pattern from PSDM:TimeBasedSimpleValueFactory
    }
}
simona.input.grid.datasource.id = "string"
#@optional
simona.input.grid.datasource.csvParams = BaseCsvParams
simona.input.weather.datasource = {

    scheme = "string" | "icon" # Describes the scheme, in which the data comes. Permissible values : icon, cosmo
    #@optional
    sampleParams = {
      use: "boolean" | true # dummy parameter to allow sample data
    }
    #@optional
    timestampPattern = string
    #@optional
    resolution = long
    maxCoordinateDistance = double | 50000
    #@optional
    csvParams = BaseCsvParams
    #@optional
    influxDb1xParams = {
      url:  string
      port: Int
      database: string
    }
    #@optional
    sqlParams = {
      jdbcUrl:  string
      userName: string
      password: string
      tableName: string
      schemaName: string | "public"
    }
    #@optional
    couchbaseParams = {
      url:  string
      bucketName:  string
      userName: string
      password: string
      coordinateColumnName: string
      keyPrefix: string
    }

    coordinateSource = {
        gridModel = "string" | "icon"
        #@optional
        csvParams = BaseCsvParams
      #@optional
      sampleParams = {
        use: "boolean" | true # dummy parameter to allow sample data
      }
    #@optional
    sqlParams = {
      jdbcUrl:  string
      userName: string
      password: string
      tableName: string
      schemaName: string | "public"
    }
    }
}
##################################################################
# Output Parameters
##################################################################
simona.output.base {
  dir = string
  addTimestampToOutputDir = true
}

#@optional
simona.output.sink.csv {
  fileFormat = ".csv"
  isHierarchic = Boolean | false
  filePrefix = ""
  fileSuffix = ""
  compressOutputs = "Boolean" | false
}
#@optional
simona.output.sink.influxDb1x {
  url =  string
  port = Int
  database = string
}

#@optional
simona.output.sink.kafka = ResultKafkaParams

simona.output.grid = GridOutputConfig
simona.output.participant = {
  defaultConfig = ParticipantBaseOutputConfig
  individualConfigs = [ParticipantBaseOutputConfig]
}
simona.output.thermal = {
  defaultConfig = SimpleOutputConfig
  individualConfigs = [SimpleOutputConfig]
}
simona.output.flex = Boolean | false

simona.output.log.level = String | "INFO"

##################################################################
# Runtime Configuration // todo refactor as this naming is misleading
##################################################################
#@optional
simona.runtime.selected_subgrids = [int] // todo convert this into a list of objects with startId, endId to allow for ranges and multiple ranges
#@optional
simona.runtime.selected_volt_lvls = [VoltLvlConfig]

simona.runtime.listener = {
  #@optional
  eventsToProcess = [string]

  #@optional
  kafka = RuntimeKafkaParams
}

simona.runtime.participant = {
  requestVoltageDeviationThreshold = "double | 1E-14" # Nodal voltages deviating more than this between requests in the same tick, are considered being different
  load = {
    defaultConfig = LoadRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [LoadRuntimeConfig]
  }
  pv = {
    defaultConfig = PvRuntimeConfig
    individualConfigs = [PvRuntimeConfig]
  }
  fixedFeedIn = {
    defaultConfig = FixedFeedInRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [FixedFeedInRuntimeConfig]
  }
  wec = {
    defaultConfig = WecRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [WecRuntimeConfig]
  }
  evcs = {
    defaultConfig = EvcsRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [EvcsRuntimeConfig]
  }
  hp = {
    defaultConfig = HpRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [HpRuntimeConfig]
  }
  storage = {
    defaultConfig = StorageRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [StorageRuntimeConfig]
  }
  em = {
    defaultConfig = EmRuntimeConfig # Mandatory default config (uuids are ignored, best provide "default")
    individualConfigs = [EmRuntimeConfig]
  }
}

##################################################################
# Power Flow Configuration
##################################################################
simona.powerflow.maxSweepPowerDeviation = Double // the maximum allowed deviation in power between two sweeps, before overall convergence is assumed
simona.powerflow.sweepTimeout = "duration:seconds | 30 seconds" // maximum timeout for a sweep
simona.powerflow.newtonraphson.epsilon = [Double]
simona.powerflow.newtonraphson.iterations = Int
simona.powerflow.resolution = "duration:seconds | 1 hour"
simona.powerflow.stopOnFailure = boolean | false

##################################################################
# Grid Configuration
##################################################################

#@optional
simona.gridConfig.refSystems = [RefSystemConfig]

##################################################################
# Event Configuration
##################################################################
#@optional
simona.event.listener = [
  {
    fullClassPath = string
    #@optional
    eventsToProcess = [string]
  }
]

##################################################################
# Configuration of Control Schemes
##################################################################
#@optional
simona.control = {
  transformer = [TransformerControlGroup]
}