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

scripts/envDFL.sh

@@ -494,120 +494,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 +841,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/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
   };
 

sources/Common/include/ZipErrorMessage.h

@@ -0,0 +1,15 @@
+//
+// Copyright (c) 2025, RTE (http://www.rte-france.com)
+// See AUTHORS.txt
+// All rights reserved.
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, you can obtain one at http://mozilla.org/MPL/2.0/.
+// SPDX-License-Identifier: MPL-2.0
+//
+
+#pragma once
+
+#include <libzip/ZipException.h>
+
+std::string formatZipErrorMessage(const zip::ZipException& e);