#810 Add the possibility to zip the inputs and outputs for N simulation

cmake/TestMain.cmake

@@ -8,6 +8,9 @@
 #
 
 set(_command ${EXE} --network=res/TestIIDM_${TEST_NAME}.iidm --config=res/config_${TEST_NAME}.json)
+if(${USE_ZIP} STREQUAL "YES")
+  list(APPEND _command --input-archive=res/${TEST_NAME}.zip)
+endif()
 message(STATUS "Execute process: ${_command}")
 execute_process(COMMAND ${_command} RESULT_VARIABLE _result)
 if(_result)

cmake/TestMainNSA.cmake

@@ -8,6 +8,9 @@
 #
 
 set(_dfl_cmd ${EXE} --network=res/TestIIDM_${TEST_NAME}.iidm --config=res/config_${TEST_NAME}.json --contingencies=res/contingencies_${TEST_NAME}.json --nsa)
+if(${USE_ZIP} STREQUAL "YES")
+  list(APPEND _dfl_cmd --input-archive=res/${TEST_NAME}.zip)
+endif()
 if(NOT DEFINED USE_MPI OR USE_MPI STREQUAL "")
   message(FATAL_ERROR "USE_MPI is not defined")
 endif()

cmake/TestMainSA.cmake

@@ -8,6 +8,9 @@
 #
 
 set(_dfl_cmd ${EXE} --network=res/TestIIDM_${TEST_NAME}.iidm --config=res/config_${TEST_NAME}.json --contingencies=res/contingencies_${TEST_NAME}.json)
+if(${USE_ZIP} STREQUAL "YES")
+  list(APPEND _dfl_cmd --input-archive=res/${TEST_NAME}.zip)
+endif()
 if(NOT DEFINED USE_MPI OR USE_MPI STREQUAL "")
   message(FATAL_ERROR "USE_MPI is not defined")
 endif()

etc/Dictionaries/DFLError_en_GB.dic

@@ -33,7 +33,8 @@ MissingICInWarmStartingPointMode =  no initial condition (p, q, v or theta) was
 
 //------------------ Outputs -----------------------
 MissingGeneratorHvdcParameterInSettings = parameter %1% not found in settings file for generator or hvdc %2%
-NoSVCInFlatStartingPointMode =        simulation of secondary voltage controls is not possible with 'FLAT' starting point mode
+NoSVCInFlatStartingPointMode =     simulation of secondary voltage controls is not possible with 'FLAT' starting point mode
+FileCreationFailed           =     failed to create %1%
 //------------------ Main ---------------------------
 EnvVariableMissing           =     cannot find environnement variable %1% please check runtime environment
 NetworkFileNotFound          =     network file %1% does not exist

scripts/envDFL.sh

@@ -161,22 +161,26 @@ where [option] can be:
         update-references                         update MAIN tests references
 
         =========== Launch
-        launch [network] [config]                 launch DynaFlow Launcher:
+        launch [network] [config] --input-archive [archive]
+                                                  launch DynaFlow Launcher:
                                                   - network: filepath (only IIDM is supported)
                                                   - config: filepath (JSON configuration file)
+                                                  - archive: path to a zip archive containing the network and configuration
 
-        launch-sa [network] [config] [contingencies] --nbThreads [nbprocs]
+        launch-sa [network] [config] [contingencies] --input-archive [archive] --nbThreads [nbprocs]
                                                   launch DynaFlow Launcher to run a Security Analysis:
                                                   - network: filepath (only IIDM is supported)
                                                   - config: filepath (JSON configuration file)
                                                   - contingencies: filepath (JSON file)
+                                                  - archive: path to a zip archive containing the network, configuration and contingencies
                                                   - nbprocs: number of MPI processes to use for SA (default 1)
 
-        launch-nsa [network] [config] [contingencies] --nbThreads [nbprocs]
+        launch-nsa [network] [config] [contingencies] --input-archive [archive] --nbThreads [nbprocs]
                                                   launch DynaFlow Launcher to run a steadystate calculcation followed by a security Analysis:
                                                   - network: filepath (only IIDM is supported)
                                                   - config: filepath (JSON configuration file)
                                                   - contingencies: filepath (JSON file)
+                                                  - archive: path to a zip archive containing the network, configuration and contingencies
                                                   - nbprocs: number of MPI processes to use for SA (default 1)
 
 
@@ -494,120 +498,221 @@ build_tests_coverage() {
 }
 
 launch() {
+  if [ -n "$ZIP_ARCHIVE" ]; then
+    $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
+    --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+    --network $2 \
+    --config $3 \
+    --input-archive $ZIP_ARCHIVE
+  else
     if [ ! -f "$2" ]; then
-        error_exit "IIDM network file $2 doesn't exist"
+      error_exit "IIDM network file $2 doesn't exist"
     fi
     if [ ! -f "$3" ]; then
-        error_exit "DFL configuration file $3 doesn't exist"
+      error_exit "DFL configuration file $3 doesn't exist"
     fi
     $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
     --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
     --network $2 \
     --config $3
+  fi
 }
 
 launch_gdb() {
+  if [ -n "$ZIP_ARCHIVE" ]; then
+    gdb --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
+    --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+    --network $2 \
+    --config $3 \
+    --input-archive $ZIP_ARCHIVE
+  else
     if [ ! -f "$2" ]; then
-        error_exit "IIDM network file $1 doesn't exist"
+      error_exit "IIDM network file $1 doesn't exist"
     fi
     if [ ! -f "$3" ]; then
-        error_exit "DFL configuration file $2 doesn't exist"
+      error_exit "DFL configuration file $2 doesn't exist"
     fi
     gdb --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
     --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
     --network $2 \
     --config $3
+  fi
 }
 
 launch_valgrind() {
+  if [ -n "$ZIP_ARCHIVE" ]; then
+    valgrind --tool=callgrind --dump-instr=yes --collect-jumps=yes $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
+    --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+    --network $2 \
+    --config $3 \
+    --input-archive $ZIP_ARCHIVE
+  else
     if [ ! -f "$2" ]; then
-        error_exit "IIDM network file $1 doesn't exist"
+      error_exit "IIDM network file $1 doesn't exist"
     fi
     if [ ! -f "$3" ]; then
-        error_exit "DFL configuration file $2 doesn't exist"
+      error_exit "DFL configuration file $2 doesn't exist"
     fi
     valgrind --tool=callgrind --dump-instr=yes --collect-jumps=yes $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher \
     --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
     --network $2 \
     --config $3
+  fi
 }
 
 
 launch_sa() {
-    if [ ! -f "$2" ]; then
+  export_preload
+  if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      "$MPIRUN_PATH" -np $NBPROCS $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                                                      --network $2 \
+                                                                                      --config $3 \
+                                                                                      --contingencies $4 \
+                                                                                      --input-archive $ZIP_ARCHIVE
+    else
+      if [ ! -f "$2" ]; then
         error_exit "IIDM network file $2 doesn't exist"
-    fi
-    if [ ! -f "$3" ]; then
+      fi
+      if [ ! -f "$3" ]; then
         error_exit "DFL configuration file $3 doesn't exist"
-    fi
-    if [ ! -f "$4" ]; then
+      fi
+      if [ ! -f "$4" ]; then
         error_exit "Security Analysis contingencies file $4 doesn't exist"
-    fi
-    export_preload
-    if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+      fi
       "$MPIRUN_PATH" -np $NBPROCS $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                                                       --network $2 \
                                                                                       --config $3 \
                                                                                       --contingencies $4
+    fi
+  else
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                          --network $2 \
+                                                          --config $3 \
+                                                          --contingencies $4 \
+                                                          --input-archive $ZIP_ARCHIVE
     else
+      if [ ! -f "$2" ]; then
+        error_exit "IIDM network file $2 doesn't exist"
+      fi
+      if [ ! -f "$3" ]; then
+        error_exit "DFL configuration file $3 doesn't exist"
+      fi
+      if [ ! -f "$4" ]; then
+        error_exit "Security Analysis contingencies file $4 doesn't exist"
+      fi
       $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                           --network $2 \
                                                           --config $3 \
                                                           --contingencies $4
     fi
-    unset LD_PRELOAD
+  fi
+  unset LD_PRELOAD
 }
 
 launch_nsa() {
-    if [ ! -f "$2" ]; then
+  export_preload
+  if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      "$MPIRUN_PATH" -np $NBPROCS $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                                                      --network $2 \
+                                                                                      --config $3 \
+                                                                                      --contingencies $4 \
+                                                                                      --input-archive $ZIP_ARCHIVE \
+                                                                                      --nsa # Steady state calculations.
+    else
+      if [ ! -f "$2" ]; then
         error_exit "IIDM network file $2 doesn't exist"
-    fi
-    if [ ! -f "$3" ]; then
+      fi
+      if [ ! -f "$3" ]; then
         error_exit "DFL configuration file $3 doesn't exist"
-    fi
-    if [ ! -f "$4" ]; then
+      fi
+      if [ ! -f "$4" ]; then
         error_exit "Security Analysis contingencies file $4 doesn't exist"
-    fi
-    export_preload
-    if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+      fi
       "$MPIRUN_PATH" -np $NBPROCS $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                                                       --network $2 \
                                                                                       --config $3 \
                                                                                       --contingencies $4 \
                                                                                       --nsa # Steady state calculations.
+    fi
+  else
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                          --network $2 \
+                                                          --config $3 \
+                                                          --contingencies $4 \
+                                                          --input-archive $ZIP_ARCHIVE \
+                                                          --nsa # Steady state calculations.
     else
+      if [ ! -f "$2" ]; then
+        error_exit "IIDM network file $2 doesn't exist"
+      fi
+      if [ ! -f "$3" ]; then
+        error_exit "DFL configuration file $3 doesn't exist"
+      fi
+      if [ ! -f "$4" ]; then
+        error_exit "Security Analysis contingencies file $4 doesn't exist"
+      fi
       $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                           --network $2 \
                                                           --config $3 \
                                                           --contingencies $4 \
                                                           --nsa # Steady state calculations.
     fi
-    unset LD_PRELOAD
+  fi
+  unset LD_PRELOAD
 }
 
 launch_sa_gdb() {
-    if [ ! -f "$2" ]; then
+  export_preload
+  if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      "$MPIRUN_PATH" -np $NBPROCS xterm -e gdb -q --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                                                                              --network $2 \
+                                                                                                              --config $3 \
+                                                                                                              --contingencies $4 \
+                                                                                                              --input-archive $ZIP_ARCHIVE
+    else
+      if [ ! -f "$2" ]; then
         error_exit "IIDM network file $2 doesn't exist"
-    fi
-    if [ ! -f "$3" ]; then
+      fi
+      if [ ! -f "$3" ]; then
         error_exit "DFL configuration file $3 doesn't exist"
-    fi
-    if [ ! -f "$4" ]; then
+      fi
+      if [ ! -f "$4" ]; then
         error_exit "Security Analysis contingencies file $4 doesn't exist"
-    fi
-    export_preload
-    if [ "${DYNAWO_USE_MPI}" == "YES" ]; then
+      fi
       "$MPIRUN_PATH" -np $NBPROCS xterm -e gdb -q --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                                                                               --network $2 \
                                                                                                               --config $3 \
                                                                                                               --contingencies $4
+    fi
+  else
+    if [ -n "$ZIP_ARCHIVE" ]; then
+      gdb -q --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
+                                                                        --network $2 \
+                                                                        --config $3 \
+                                                                        --contingencies $4 \
+                                                                        --input-archive $ZIP_ARCHIVE
     else
+      if [ ! -f "$2" ]; then
+        error_exit "IIDM network file $2 doesn't exist"
+      fi
+      if [ ! -f "$3" ]; then
+        error_exit "DFL configuration file $3 doesn't exist"
+      fi
+      if [ ! -f "$4" ]; then
+        error_exit "Security Analysis contingencies file $4 doesn't exist"
+      fi
       gdb -q --args $DYNAFLOW_LAUNCHER_INSTALL_DIR/bin/DynaFlowLauncher --log-level $DYNAFLOW_LAUNCHER_LOG_LEVEL \
                                                                         --network $2 \
                                                                         --config $3 \
                                                                         --contingencies $4
     fi
-    unset LD_PRELOAD
+  fi
+  unset LD_PRELOAD
 }
 
 version() {
@@ -740,11 +845,19 @@ case "$1" in
         ;;
 esac
 
-# Nb Threads
+# parse options
 ARGS=""
 while (($#)); do
     key="$1"
     case "$key" in
+      --input-archive)
+        ZIP_ARCHIVE=$2
+        shift 2 # pass argument and value
+        ;;
+      --input-archive=*)
+        ZIP_ARCHIVE="${1#*=}"
+        shift # past value
+      ;;
       --nbThreads|-np)
         NBPROCS=$2
         shift 2 # pass argument and value

sources/Common/CMakeLists.txt

@@ -12,6 +12,7 @@ configure_file(${CMAKE_SOURCE_DIR}/cmake/version.h.in ${CMAKE_CURRENT_SOURCE_DIR
 set(SOURCES
 src/Options.cpp
 src/Log.cpp
+src/ZipErrorMessage.cpp
 src/DFLLog_keys.cpp
 src/DFLError_keys.cpp
 )
@@ -53,6 +54,7 @@ target_link_libraries(dfl_Common
 
   PRIVATE
     Boost::filesystem
+    libZIP::libZIP
 )
 add_library(DynaFlowLauncher::common ALIAS dfl_Common)
 install(FILES ${CMAKE_SOURCE_DIR}/etc/Dictionaries/DFLLog_en_GB.dic ${CMAKE_SOURCE_DIR}/etc/Dictionaries/DFLError_en_GB.dic DESTINATION share)

sources/Common/include/Log.h

@@ -49,6 +49,20 @@ class Log {
    * @param outputDir directory where the log should be written
    */
   static void init(const common::Options& options, const std::string& outputDir);
+
+  /**
+   * @brief Put the content of a log file in a map
+   *
+   * This function reads the content of a log file specified by its absolute path and stores it as a string in the
+   * provided map, using the relative path as the key.
+   *
+   * @param logFileRelativePath the relative path to the log file, used as the key in the map
+   * @param logFileAbsolutePath the absolute path to the log file, used to locate and read its content
+   * @param mapData the map where the log file content is stored, with the relative path as the key
+   */
+  static void addLogFileContentInMapData(const std::string& logFileRelativePath,
+                                          const std::string& logFileAbsolutePath,
+                                          std::unordered_map<std::string, std::string>& mapData);
 };
 
 }  // namespace common

sources/Common/include/Options.h

@@ -9,7 +9,6 @@
 
 #pragma once
 
-#include <boost/optional.hpp>
 #include <boost/program_options.hpp>
 #include <iostream>
 #include <string>
@@ -43,6 +42,7 @@ class Options {
     std::string networkFilePath;        ///< Network filepath to process
     std::string contingenciesFilePath;  ///< Contingencies filepath for security analysis
     std::string configPath;             ///< Launcher configuration filepath
+    std::string zipArchivePath;         ///< zip archive path to unzip to get input files
     std::string dynawoLogLevel;         ///< chosen log level
   };