Some refactoring.

Author: staudtMarius

README.md

@@ -2,7 +2,6 @@
 
 
 
-
 ## About
 
 Simosaik is an external simulation for the agent-based discrete-event power system simulation model [SIMONA](https://github.com/ie3-institute/simona).
@@ -20,23 +19,25 @@ You have to use the following branches:
 
 - simosaik: `main`
 - simonaAPI: `ms/ReCoDe`
-- simona: `ms/simosaik-dev`
+- simona: `ms/ReCoDe`
 
 
 **Step 2:** <br>
 Add the mosaik API to the folder `./libs`.
 
 
 **Step 3:** <br>
-After selecting these branches, you have to run the following `shadowJar` on SIMONA and simosaik.
+To create executable jars, you have to run the task `shadowJar` on SIMONA and simosaik.
 
 
 **Step 4:** <br>
-Add an execution of the jar containing SIMONA to your MOSAIK scenario.
-
+Add the following statement to your mosaik simulation configuration:
+``'SimonaPowerGrid': {
+   'cmd': 'java -cp path/to/simonaJar edu.ie3.simona.main.RunSimonaStandalone --config=path/to/simona/configuration/file --ext-address=%(addr)s',
+}``
 
 **Step 5:** <br>
-Add the following to your SIMONA configuration file: 
+Add the following configuration to your SIMONA configuration file: 
 
 - ``simona.input.extSimDir = "path/to/simosaik.jar"``
 
@@ -50,6 +51,6 @@ Add the following to your SIMONA configuration file:
 The following simulations can be selected:
 
 - `PrimaryResult`: Provides SIMONA with primary data and MOSAIK with SIMONA results
-- `MosaikOptimizer`: Optimizer for em agents in SIMONA
+- `FlexOptionOptimizer`: Optimizer for em agents or models with flexibility options in SIMONA
 
 If no simulation is selected, simosaik will use the `PrimaryResult` simulation.

build.gradle

@@ -1,5 +1,3 @@
-import com.github.jengelman.gradle.plugins.shadow.transformers.AppendingTransformer
-
 plugins {
   id 'java' // java support
   id 'scala' // scala support
@@ -29,7 +27,6 @@ java {
 }
 
 apply from: scriptsLocation + 'spotless.gradle'
-apply from: scriptsLocation + 'tscfg.gradle' // config tasks
 
 configurations {
   scalaCompilerPlugin

gradle/scripts/tscfg.gradle

@@ -19,13 +19,17 @@
 /** Methods for simplifying the creation of mosaik meta information. */
 public interface MetaUtils {
 
+  static Map<String, Object> createMetaWithPowerGrid(String type, ModelParams... additionalModels) {
+    return createMeta(type, ModelParams.simonaPowerGridEnvironment(), List.of(additionalModels));
+  }
+
   static Map<String, Object> createMeta(
       String type, ModelParams simonaPowerGrid, ModelParams... additionalModels) {
     return createMeta(type, simonaPowerGrid, List.of(additionalModels));
   }
 
   @SuppressWarnings("unchecked")
-  static Map<String, Object> createMeta(
+  private static Map<String, Object> createMeta(
       String type, ModelParams simonaPowerGrid, List<ModelParams> additionalModels) {
     JSONObject meta = new JSONObject();
     meta.put("api_version", Simulator.API_VERSION);
@@ -45,16 +49,26 @@ static Map<String, Object> createMeta(
   @SuppressWarnings("unchecked")
   static JSONObject createObject(
       boolean isPublic, List<String> params, List<String> attrs, List<String> triggers) {
-    JSONArray paramArray = new JSONArray();
-    if (params != null) paramArray.addAll(params);
-
-    JSONArray attrArray = new JSONArray();
-    if (attrs != null) attrArray.addAll(attrs);
-
     JSONObject obj = new JSONObject();
     obj.put("public", isPublic);
-    obj.put("params", paramArray);
-    obj.put("attrs", attrArray);
+
+    if (params != null) {
+      JSONArray paramArray = new JSONArray();
+      paramArray.addAll(params);
+      obj.put("params", paramArray);
+    }
+
+    if (attrs != null) {
+      JSONArray attrArray = new JSONArray();
+      attrArray.addAll(attrs);
+      obj.put("attrs", attrArray);
+    }
+
+    if (triggers != null) {
+      JSONArray triggerArray = new JSONArray();
+      triggerArray.addAll(triggers);
+      obj.put("triggers", triggerArray);
+    }
 
     return obj;
   }

src/main/java/edu/ie3/simosaik/MetaUtils.java

@@ -21,8 +21,8 @@ public abstract class MosaikSimulator extends Simulator implements SimonaEntitie
 
   public final int stepSize;
 
-  protected DataQueueExtSimulationExtSimulator<ExtInputDataContainer> dataQueueMosaikToSimona;
-  protected DataQueueExtSimulationExtSimulator<ExtResultContainer> dataQueueSimonaToMosaik;
+  public DataQueueExtSimulationExtSimulator<ExtInputDataContainer> dataQueueMosaikToSimona;
+  public DataQueueExtSimulationExtSimulator<ExtResultContainer> dataQueueSimonaToMosaik;
 
   public MosaikSimulator(String name, int stepSize) {
     super(name);

src/main/java/edu/ie3/simosaik/MosaikSimulator.java

@@ -10,7 +10,7 @@
 import edu.ie3.simona.api.simulation.ExtSimAdapterData;
 import edu.ie3.simosaik.config.ArgsParser;
 import edu.ie3.simosaik.primaryResultSimulator.PrimaryResultSimulation;
-import edu.ie3.simosaik.simosaikFlexOptionOptimizer.MosaikOptimizerSimulation;
+import edu.ie3.simosaik.simosaikFlexOptionOptimizer.FlexOptionOptimizerSimulation;
 import java.nio.file.Path;
 
 public class SimosaikExtLink implements ExtLinkInterface {
@@ -27,11 +27,17 @@ public void setup(ExtSimAdapterData data) {
 
     String mosaikIP = arguments.mosaikIP();
     Path mappingPath = arguments.mappingPath();
+    int stepSize = arguments.stepSize();
 
     extSim =
         switch (arguments.simulation()) {
-          case PRIMARY_RESULT -> new PrimaryResultSimulation(mosaikIP, mappingPath);
-          case MOSAIK_OPTIMIZER -> new MosaikOptimizerSimulation(mosaikIP, mappingPath);
+          case PRIMARY_RESULT -> new PrimaryResultSimulation(mosaikIP, mappingPath, stepSize);
+          case FLEX_OPTION_OPTIMIZER ->
+              new FlexOptionOptimizerSimulation(
+                  mosaikIP,
+                  mappingPath,
+                  stepSize,
+                  arguments.useFlexOptionEntitiesInsteadOfEmAgents());
         };
 
     extSim.setAdapterData(data);

src/main/java/edu/ie3/simosaik/SimosaikExtLink.java

@@ -126,14 +126,23 @@ public static Map<String, Object> createSimosaikOutputMap(
 
   public static void addResult(
       ExtResultContainer results, String id, String attr, Map<String, Object> outputMap) {
-    if (equalsAny(attr, MOSAIK_VOLTAGE_DEVIATION_PU, MOSAIK_VOLTAGE_PU)) {
+    if (equalsAny(attr, MOSAIK_VOLTAGE_DEVIATION_PU)) {
       if (results.getTick() == 0L) {
         outputMap.put(attr, 0d);
       } else {
         // grid related results are not sent in time step zero
         outputMap.put(attr, results.getVoltageDeviation(id));
       }
     }
+    if (equalsAny(attr, MOSAIK_VOLTAGE_PU)) {
+      if (results.getTick() == 0L) {
+        outputMap.put(attr, 1d);
+      } else {
+        // grid related results are not sent in time step zero
+        outputMap.put(attr, results.getVoltageDeviation(id));
+      }
+    }
+
     if (equalsAny(attr, MOSAIK_ACTIVE_POWER, MOSAIK_ACTIVE_POWER_IN)) {
       outputMap.put(attr, results.getActivePower(id));
     }

src/main/java/edu/ie3/simosaik/SimosaikUtils.java

@@ -22,9 +22,16 @@ public class ArgsParser {
    * @param mosaikIP the IP of the socket
    * @param mappingPath path for the {@link ExtEntityMapping}
    * @param simulation the {@link MosaikSimulator}
+   * @param stepSize option for the step size
+   * @param useFlexOptionEntitiesInsteadOfEmAgents false, to communicate with em agents
    */
   public record Arguments(
-      String[] mainArgs, String mosaikIP, Path mappingPath, Simulation simulation) {}
+      String[] mainArgs,
+      String mosaikIP,
+      Path mappingPath,
+      Simulation simulation,
+      int stepSize,
+      boolean useFlexOptionEntitiesInsteadOfEmAgents) {}
 
   /**
    * Method for parsing the provided arguments.
@@ -45,7 +52,13 @@ public static Arguments parse(String[] args) {
     Path configPath = Path.of(extract(parsedArgs, "--config"));
     SimosaikConfig config = SimosaikConfig.load(configPath);
 
-    return new Arguments(args, mosaikIP, config.mappingPath(), config.simulation());
+    return new Arguments(
+        args,
+        mosaikIP,
+        config.mappingPath(),
+        config.simulation(),
+        config.stepSize(),
+        config.useFlexOptionEntitiesInsteadOfEmAgents());
   }
 
   /**

src/main/java/edu/ie3/simosaik/config/ArgsParser.java

@@ -7,19 +7,29 @@
 package edu.ie3.simosaik.config;
 
 import com.typesafe.config.Config;
+import com.typesafe.config.ConfigException;
 import com.typesafe.config.ConfigFactory;
+import edu.ie3.datamodel.utils.Try;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.time.Duration;
 import java.util.Optional;
 
-public record SimosaikConfig(Path mappingPath, Simulation simulation) {
+public record SimosaikConfig(
+    Path mappingPath,
+    Simulation simulation,
+    int stepSize,
+    boolean useFlexOptionEntitiesInsteadOfEmAgents) {
 
   public static SimosaikConfig load(Path filePath) {
     if (!Files.isReadable(filePath)) {
       throw new IllegalArgumentException("Config file at " + filePath + " is not readable.");
     }
 
-    Config config = ConfigFactory.parseFile(filePath.toFile()).getConfig("simosaik");
+    Config baseConfig = ConfigFactory.parseFile(filePath.toFile());
+    int stepSize = getStepSize(baseConfig);
+
+    Config config = baseConfig.getConfig("simosaik");
 
     String simulation;
     try {
@@ -28,7 +38,21 @@ public static SimosaikConfig load(Path filePath) {
       simulation = "PrimaryResult";
     }
 
+    boolean useFlexOptionEntitiesInsteadOfEmAgents = false;
+    // config.getBoolean("useFlexOptionEntitiesInsteadOfEmAgents");
+
     return new SimosaikConfig(
-        Path.of(config.getString("mappingPath")), Simulation.parse(simulation));
+        Path.of(config.getString("mappingPath")),
+        Simulation.parse(simulation),
+        stepSize,
+        useFlexOptionEntitiesInsteadOfEmAgents);
+  }
+
+  private static int getStepSize(Config baseConfig) {
+    Try.TrySupplier<Duration, ConfigException> supplier =
+        () -> baseConfig.getConfig("simona").getConfig("powerflow").getDuration("resolution");
+    return Try.of(supplier, ConfigException.class)
+        .map(duration -> (int) duration.toSeconds())
+        .getOrThrow();
   }
 }

src/main/java/edu/ie3/simosaik/config/SimosaikConfig.java

@@ -8,12 +8,12 @@
 
 public enum Simulation {
   PRIMARY_RESULT,
-  MOSAIK_OPTIMIZER;
+  FLEX_OPTION_OPTIMIZER;
 
   public static Simulation parse(String simulation) {
     return switch (simulation.toLowerCase()) {
       case "primaryresult" -> PRIMARY_RESULT;
-      case "mosaikoptimizer" -> MOSAIK_OPTIMIZER;
+      case "flexoptionoptimizer" -> FLEX_OPTION_OPTIMIZER;
       default -> throw new IllegalStateException("Unexpected value: " + simulation.toLowerCase());
     };
   }

src/main/java/edu/ie3/simosaik/config/Simulation.java

@@ -19,8 +19,12 @@ public class PrimaryResultSimulation extends MosaikSimulation {
   private final ExtPrimaryDataConnection extPrimaryDataConnection;
   private final ExtResultDataConnection extResultDataConnection;
 
-  public PrimaryResultSimulation(String mosaikIP, Path mappingPath) {
-    super("MosaikPrimaryResultSimulation", mosaikIP, mappingPath, new PrimaryResultSimulator());
+  public PrimaryResultSimulation(String mosaikIP, Path mappingPath, int stepSize) {
+    super(
+        "MosaikPrimaryResultSimulation",
+        mosaikIP,
+        mappingPath,
+        new PrimaryResultSimulator(stepSize));
 
     // set up connection
     this.extPrimaryDataConnection = buildPrimaryConnection(mapping, log);
@@ -36,7 +40,10 @@ public Set<ExtDataConnection> getDataConnections() {
   protected Optional<Long> activity(long tick, long nextTick) throws InterruptedException {
     Optional<Long> maybeNextTick = Optional.of(nextTick);
 
+    // sending primary data to SIMONA
     sendPrimaryDataToSimona(extPrimaryDataConnection, tick, maybeNextTick, log);
+
+    // sending results to mosaik
     sendResultToExt(extResultDataConnection, tick, maybeNextTick, log);
 
     return maybeNextTick;

src/main/java/edu/ie3/simosaik/primaryResultSimulator/PrimaryResultSimulation.java

@@ -21,19 +21,14 @@ public class PrimaryResultSimulator extends MosaikSimulator {
   private Set<String> simonaPrimaryEntities;
   private Set<String> simonaResultEntities;
 
-  public PrimaryResultSimulator() {
-    super("PrimaryResultSimulator", 900);
-  }
-
   public PrimaryResultSimulator(int stepSize) {
     super("PrimaryResultSimulator", stepSize);
   }
 
   @Override
   public Map<String, Object> init(String sid, Float timeResolution, Map<String, Object> simParams) {
-    return MetaUtils.createMeta(
+    return MetaUtils.createMetaWithPowerGrid(
         "time-based",
-        ModelParams.simonaPowerGridEnvironment(),
         ModelParams.of(PRIMARY_INPUT_ENTITIES),
         ModelParams.of(RESULT_OUTPUT_ENTITIES));
   }