Extend --help for ecm_prep.py per #249

trynthink · Jan 18, 2024 · 3ac6eb5 · 3ac6eb5
1 parent 25ee48a
commit 3ac6eb5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/scout/ecm_prep_args.py b/scout/ecm_prep_args.py
@@ -12,7 +12,10 @@ def ecm_args(args: list) -> argparse.NameSpace:  # noqa: F821
     """
 
     # Retrieve config file and CLI arguments
-    parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
+    parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter,
+                            epilog="For more detail please read: "
+                            "https://scout-bto.readthedocs.io/en/latest/tutorials.html"
+                            "#tutorial-2-preparing-ecms-for-analysis")
     config = Config(parser, "ecm_prep", args)
     opts = config.parse_args()
     opts = translate_inputs(opts)  # Translate for use downstream

diff --git a/scout/supporting_data/config_schema.yml b/scout/supporting_data/config_schema.yml
@@ -99,7 +99,7 @@ properties:
       health_costs:
         type: boolean
         default: false
-        description: Enable health costs.
+        description: Enable health costs. Requires alt_regions to be set to `EMM`.
 
       split_fuel:
         type: boolean

diff --git a/tests/test_files/default_config.yml b/tests/test_files/default_config.yml
@@ -6,7 +6,7 @@ ecm_prep:
   sect_shapes: false
   rp_persist: false
   verbose: false
-  health_costs: true
+  health_costs: false
   split_fuel: false
   no_scnd_lgt: false
   floor_start: null