Round values between -1e-5 and 1e-5 to 0

Author: staadecker

switch_model/reporting/__init__.py

@@ -62,13 +62,13 @@ def define_arguments(argparser):
     )
 
 
-def get_cell_formatter(sig_digits):
+def get_cell_formatter(sig_digits, zero_cutoff):
     sig_digits_formatter = "{0:." + str(sig_digits) + "g}"
 
     def format_cell(c):
         if not isinstance(c, float):
             return c
-        if abs(c) < 1e-8:
+        if abs(c) < zero_cutoff:
             return 0
         else:
             return sig_digits_formatter.format(c)
@@ -86,7 +86,9 @@ def write_table(instance, *indexes, output_file=None, **kwargs):
     # don't know what that is.
     if output_file is None:
         raise Exception("Must specify output_file in write_table()")
-    cell_formatter = get_cell_formatter(instance.options.sig_figs_output)
+    cell_formatter = get_cell_formatter(
+        instance.options.sig_figs_output, instance.options.zero_cutoff_output
+    )
 
     if "df" in kwargs:
         df = kwargs.pop("df")
@@ -153,7 +155,9 @@ def post_solve(instance, outdir):
 
 
 def save_generic_results(instance, outdir, sorted_output):
-    cell_formatter = get_cell_formatter(instance.options.sig_figs_output)
+    cell_formatter = get_cell_formatter(
+        instance.options.sig_figs_output, instance.options.zero_cutoff_output
+    )
 
     components = list(instance.component_objects(Var))
     # add Expression objects that should be saved, if any

switch_model/solve.py

@@ -730,6 +730,12 @@ def define_arguments(argparser):
         type=int,
         help="The number of significant digits to include in the output by default",
     )
+    argparser.add_argument(
+        "--zero-cutoff-output",
+        default=1e-5,
+        type=float,
+        help="If the magnitude of an output value is less than this value, it is rounded to 0.",
+    )
 
     argparser.add_argument(
         "--sorted-output",