Rework of the CLI argument parser and add the option to define inputs through a JSON file

.github/workflows/build-mac.yml

@@ -18,7 +18,7 @@ jobs:
       with:
           persist-credentials: false
     - name: installPackages
-      run: brew install eigen && brew install gsl && brew install nlopt && brew install boost && brew install libomp
+      run: brew install eigen && brew install gsl && brew install nlopt && brew install boost && brew install libomp && brew install nlohmann-json
     - name: Get number of CPU cores
       uses: SimenB/github-actions-cpu-cores@v1
       id: cpu-cores

.github/workflows/build.yml

@@ -10,15 +10,15 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     if: "!contains(github.event.head_commit.message, 'skip-ci')"
 
     steps:
     - uses: actions/checkout@v3
       with:
           persist-credentials: false
     - name : installPackages
-      run : sudo apt-get install --no-install-recommends --yes libgsl-dev libeigen3-dev libnlopt-dev libnlopt-cxx-dev libboost-all-dev
+      run : sudo apt-get install --no-install-recommends --yes libgsl-dev libeigen3-dev libnlopt-dev libnlopt-cxx-dev libboost-all-dev nlohmann-json3-dev
     - name: Get number of CPU cores
       uses: SimenB/github-actions-cpu-cores@v1
       id: cpu-cores

CMakeLists.txt

@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.13)
 project(
   BSMPT
-  VERSION 2.4.0
+  VERSION 2.5.0
   LANGUAGES C CXX
   DESCRIPTION "BSMPT - Beyond the Standard Model Phase Transitions : A C++ package for the computation of the EWPT in BSM models")
 
@@ -62,7 +62,8 @@ if(UseConan)
 	include(conan)
 	set(ConanPkgList eigen/3.4.0 
 				     gsl/2.7				     
-				     boost/1.78.0)
+						 boost/1.78.0
+						 nlohmann_json/3.10.5)
 
 	if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
 	        set(ConanPkgList ${ConanPkgList} benchmark/1.6.1)
@@ -88,6 +89,7 @@ find_package(PkgConfig)
 find_package(Eigen3 3.3.0 REQUIRED)
 find_package(Boost 1.66)
 find_package(GSL 2.1 REQUIRED)
+find_package(nlohmann_json 3.10.0)
 
 
 
@@ -117,6 +119,10 @@ if(Boost_FOUND)
   endif()
 endif()
 
+if(nlohmann_json_FOUND)
+  set(CodeCoverageExcludesFromOtherPkgs ${CodeCoverageExcludesFromOtherPkgs} "${nlohmann_json}/*")
+endif()
+
 set(EXPORT_CMAES FALSE)
 include(FetchContent)
 if(UseLibCMAES AND NOT WIN32)

README.md

@@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2021 Philipp Basler, Margarete Mühlleitner and Jonas M
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
-Program: BSMPT version 2.4.0
+Program: BSMPT version 2.5.0
 
 Released by: Philipp Basler and Lisa Biermann and Margarete Mühlleitner and Jonas Müller
 
@@ -137,6 +137,9 @@ Also contact us if you have a custom model for BSMPT v1.x and you have trouble c
 
 ## Executables
 BSMPT provides multiple executables. Here we give a quick overview of them. For every executable you can call them with the `--help` option to get an overview of possible input parameters.
+
+Additionally, every executable has the option to set the `--json=/path/to/your/file.json` which contains a json string with the parameters you can set through the CLI. This can be useful if you want to store the parameters you used for a given call. Please beware that all paths in the json file are considered relative to the current working directory and not to the location of the json file. Examples can be found in `example/JSON`.
+
 For the following examples the C2HDM with the example/C2HDM_Input.dat file is used.
 
 ### BSMPT

example/JSON/BSMPT.json

@@ -0,0 +1,17 @@
+{
+    "FirstLine": "2",
+    "LastLine": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/CalcCT.json

@@ -0,0 +1,13 @@
+{
+    "FirstLine": "2",
+    "LastLine": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/CalculateEWBG.json

@@ -0,0 +1,19 @@
+{
+    "FirstLine": "2",
+    "LastLine": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "config": "./example/EWBG_config.txt",
+
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/NLOVEV.json

@@ -0,0 +1,17 @@
+{
+    "FirstLine": "2",
+    "LastLine": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/PlotEWBG_nL.json

@@ -0,0 +1,19 @@
+{
+    "Line": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "config": "./example/EWBG_config.txt",
+    "vw": "0.1",
+
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/PlotEWBG_vw.json

@@ -0,0 +1,21 @@
+{
+    "Line": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "config": "./example/EWBG_config.txt",
+    "vw_min": "0.1",
+    "vw_max": "0.2",
+    "vw_stepsize": "0.05",
+
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/Test.json

@@ -0,0 +1,14 @@
+{
+    "line": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "model": "c2hdm",
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/TripleHiggsCouplingsNLO.json

@@ -0,0 +1,13 @@
+{
+    "FirstLine": "2",
+    "LastLine": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

example/JSON/VEVEVO.json

@@ -0,0 +1,20 @@
+{
+    "Line": "2",
+    "input": "./example/C2HDM_Input.dat",
+    "output": "test.tsv",
+    "model": "c2hdm",
+    "TemperatureStart": "0",
+    "TemperatureEnd": "100",
+    "TemperatureStep": "5",
+
+    "UseNLopt": "true",
+    "UseCMAES": "true",
+    "UseGSL": "true",
+    "UseMultiThreading": "true",
+    "logginglevel::default": "true",
+    "logginglevel::minimizerdetailed": "false",
+    "logginglevel::ewbgdetailed": "false",
+    "logginglevel::debug": "false",
+    "logginglevel::progdetailed": "false",
+    "logginglevel::disabled_comment": "remove _comment from key to disable logger"
+}

include/BSMPT/config.h.in

@@ -3,3 +3,6 @@
 #cmakedefine libcmaes_FOUND
 #cmakedefine NLopt_FOUND
 #cmakedefine Boost_FOUND
+#cmakedefine nlohmann_json_FOUND
+#cmakedefine Nlohmann_json_FOUND
+#cmakedefine NLOHMANN_JSON_FOUND

include/BSMPT/utility/Logger.h

@@ -18,8 +18,10 @@ namespace BSMPT
 {
 
 class Logger;
+class parser;
 
 void ShowLoggerHelp();
+void SetLogger(const parser &argparser);
 void SetLogger(const std::vector<std::string> &args);
 
 enum class LoggingLevel
@@ -37,10 +39,10 @@ class BSMPTLogger
 public:
   friend Logger;
   BSMPTLogger(std::ostream &os) : mOstream{os.rdbuf()} {}
-  BSMPTLogger(const BSMPTLogger &) = delete;
-  BSMPTLogger(BSMPTLogger &&)      = delete;
+  BSMPTLogger(const BSMPTLogger &)            = delete;
+  BSMPTLogger(BSMPTLogger &&)                 = delete;
   BSMPTLogger &operator=(const BSMPTLogger &) = delete;
-  BSMPTLogger &operator=(BSMPTLogger &&) = delete;
+  BSMPTLogger &operator=(BSMPTLogger &&)      = delete;
 
 private:
   void SetOStream(std::ostream &Ostream);
@@ -81,10 +83,10 @@ class BSMPTLogger
 class Logger
 {
 public:
-  Logger(const Logger &) = delete;
-  Logger(Logger &&)      = delete;
+  Logger(const Logger &)            = delete;
+  Logger(Logger &&)                 = delete;
   Logger &operator=(const Logger &) = delete;
-  Logger &operator=(Logger &&) = delete;
+  Logger &operator=(Logger &&)      = delete;
 
   static void SetLevel(const std::map<LoggingLevel, bool> &Setup)
   {

include/BSMPT/utility/parser.h

@@ -0,0 +1,55 @@
+#ifndef PARSER_H
+#define PARSER_H
+
+#include <optional>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+namespace BSMPT
+{
+
+class parserException : public std::exception
+{
+public:
+  virtual const char *what() const noexcept;
+  parserException(const std::string &msg);
+
+private:
+  std::string message;
+};
+
+/**
+ * @brief The parser class provides the base class for parsing CLI options
+ */
+class parser
+{
+public:
+  parser();
+  void enable_minimizer_options();
+  void add_argument(const std::string &argument,
+                    const std::string &description,
+                    bool required);
+  void add_input(const std::vector<std::string> &input);
+  void print_help() const;
+  std::string get_value(const std::string &argument) const;
+  std::string get_value_lower_case(const std::string &argument) const;
+  bool all_required_set() const;
+  void check_required_parameters() const;
+  void set_help_header(const std::string &header);
+
+private:
+  struct Options
+  {
+    std::string argument;
+    std::string description;
+    std::optional<std::string> value;
+  };
+  std::unordered_map<std::string, Options> mRequiredArguments;
+  std::unordered_map<std::string, Options> mOptionalArguments;
+  void add_cli_input(const std::vector<std::string> &input);
+  void add_json_input(const std::string &filename);
+  std::string mHeader;
+};
+} // namespace BSMPT
+#endif // PARSER_H

include/BSMPT/utility/utility.h

@@ -32,6 +32,14 @@ namespace BSMPT
  */
 bool StringStartsWith(const std::string &str, const std::string &prefix);
 
+/**
+ * @brief StringEndsWith tests if str ends with suffix
+ * @param str
+ * @param suffix
+ * @return
+ */
+bool StringEndsWith(const std::string &str, const std::string &suffix);
+
 /**
  * @brief seperator used to write into output files
  */

src/models/IncludeAllModels.cpp

@@ -48,7 +48,8 @@ ModelIDs getModel(const std::string &s)
   std::string ModelInput = s;
   std::transform(
       ModelInput.begin(), ModelInput.end(), ModelInput.begin(), ::tolower);
-  for (auto entry : ModelNames)
+
+  for (const auto &entry : ModelNames)
   {
     auto key = entry.first;
     std::transform(key.begin(), key.end(), key.begin(), ::tolower);