Merge pull request #905 from EnergySystemsModellingLab/add-no-debug-model-option

Fix `regenerate_all_data.sh` script when user has set `debug_model = true`

Author: alexdewar

src/cli.rs

@@ -36,8 +36,8 @@ pub struct RunOpts {
     #[arg(long)]
     pub overwrite: bool,
     /// Whether to write additional information to CSV files
-    #[arg(long)]
-    pub debug_model: bool,
+    #[arg(long, value_name = "BOOL", num_args = 0..=1, default_missing_value = "true")]
+    pub debug_model: Option<bool>,
 }
 
 /// The available commands.
@@ -116,8 +116,8 @@ pub fn handle_run_command(
     };
 
     // These settings can be overridden by command-line arguments
-    if opts.debug_model {
-        settings.debug_model = true;
+    if let Some(opt) = opts.debug_model {
+        settings.debug_model = opt;
     }
     if opts.overwrite {
         settings.overwrite = true;

tests/regenerate_all_data.sh

@@ -1,21 +1,21 @@
 #!/bin/sh
+set -euf
 
 mydir=$(dirname "$0")
 cd "$mydir"
 
-echo Cleaning output folder
-rm -rf data/*
-
 echo Building MUSE2
 examples=$(cargo run example list 2> /dev/null)
 
 for example in $examples; do
     echo Generating data for example: $example
 
     # We only need debug files for the simple model
-    unset extra_args
+    extra_args=--overwrite
     if [ $example = simple ]; then
-        extra_args=--debug-model
+        extra_args+=" --debug-model"
+    else
+        extra_args+=" --debug-model=false"
     fi
 
     env MUSE2_LOG_LEVEL=off cargo run example run $extra_args -o "data/$example" "$example" 2> /dev/null

tests/regression.rs

@@ -43,7 +43,7 @@ fn run_regression_test_debug_opt(example_name: &str, debug_model: bool) {
     let opts = RunOpts {
         output_dir: Some(output_dir.clone()),
         overwrite: false,
-        debug_model: true, // NB: Always enable this as it helps to have the files for debugging
+        debug_model: Some(true), // NB: Always enable this as it helps to have the files for debugging
     };
     handle_example_run_command(example_name, &opts, Some(Settings::default())).unwrap();
 

tests/run.rs

@@ -25,7 +25,7 @@ fn test_handle_run_command() {
     let opts = RunOpts {
         output_dir: Some(output_dir),
         overwrite: false,
-        debug_model: false,
+        debug_model: None,
     };
     handle_run_command(&get_model_dir(), &opts, Some(Settings::default())).unwrap();