Changeset 2414 for coopr.pysp/trunk/coopr/pysp/ef_writer_script.py

Timestamp:

Mar 8, 2010 10:18:14 PM (11 years ago)

Author:

jwatson

Message:

Various EF writer changes in PySP, including:
1) Added a --verbose option, and by default am disabling echo of the scenario tree.
2) Changed the default behavior, due to recent experience with lot sizing and wind farm examples, to enable garbage collection.
3) Added a --disable-gc option to disable garbage collection, set to False by default.

File:

• coopr.pysp/trunk/coopr/pysp/ef_writer_script.py (modified) (4 diffs)

coopr.pysp/trunk/coopr/pysp/ef_writer_script.py

@@ -24 +24 @@
 
 #
-# Setup command-line options
+# utility method to construct an option parser for ef writer arguments
 #
 
-parser = OptionParser()
-parser.add_option("--model-directory",
-                  help="The directory in which all model (reference and scenario) definitions are stored. Default is \".\".",
-                  action="store",
-                  dest="model_directory",
-                  type="string",
-                  default=".")
-parser.add_option("--instance-directory",
-                  help="The directory in which all instance (reference and scenario) definitions are stored. Default is \".\".",
-                  action="store",
-                  dest="instance_directory",
-                  type="string",
-                  default=".")
-parser.add_option("--generate-weighted-cvar",
-                  help="Add a weighted CVaR term to the primary objective",
-                  action="store_true",
-                  dest="generate_weighted_cvar",
-                  default=False)
-parser.add_option("--cvar-weight",
-                  help="The weight associated with the CVaR term in the risk-weighted objective formulation.",
-                  action="store",
-                  dest="cvar_weight",
-                  type="float",
-                  default=1.0)
-parser.add_option("--risk-alpha",
-                  help="The probability threshold associated with cvar (or any future) risk-oriented performance metrics.",
-                  action="store",
-                  dest="risk_alpha",
-                  type="float",
-                  default=0.95)
-parser.add_option("--output-file",
-                  help="Specify the name of the extensive form output file",
-                  action="store",
-                  dest="output_file",
-                  type="string",
-                  default="efout.lp")
-parser.add_option("--profile",
-                  help="Enable profiling of Python code.  The value of this option is the number of functions that are summarized.",
-                  action="store",
-                  dest="profile",
-                  default=0)
-parser.usage="efwriter [options]"
+def construct_ef_writer_options_parser(usage_string):
 
+   parser = OptionParser()
+   parser.add_option("--verbose",
+                     help="Generate verbose output, beyond the usual status output. Default is False.",
+                     action="store_true",
+                     dest="verbose",
+                     default=False)
+   parser.add_option("--model-directory",
+                     help="The directory in which all model (reference and scenario) definitions are stored. Default is \".\".",
+                     action="store",
+                     dest="model_directory",
+                     type="string",
+                     default=".")
+   parser.add_option("--instance-directory",
+                     help="The directory in which all instance (reference and scenario) definitions are stored. Default is \".\".",
+                     action="store",
+                     dest="instance_directory",
+                     type="string",
+                     default=".")
+   parser.add_option("--generate-weighted-cvar",
+                     help="Add a weighted CVaR term to the primary objective",
+                     action="store_true",
+                     dest="generate_weighted_cvar",
+                     default=False)
+   parser.add_option("--cvar-weight",
+                     help="The weight associated with the CVaR term in the risk-weighted objective formulation.",
+                     action="store",
+                     dest="cvar_weight",
+                     type="float",
+                     default=1.0)
+   parser.add_option("--risk-alpha",
+                     help="The probability threshold associated with cvar (or any future) risk-oriented performance metrics.",
+                     action="store",
+                     dest="risk_alpha",
+                     type="float",
+                     default=0.95)
+   parser.add_option("--output-file",
+                     help="Specify the name of the extensive form output file",
+                     action="store",
+                     dest="output_file",
+                     type="string",
+                     default="efout.lp")
+   parser.add_option("--profile",
+                     help="Enable profiling of Python code.  The value of this option is the number of functions that are summarized.",
+                     action="store",
+                     dest="profile",
+                     default=0)
+   parser.add_option("--disable-gc",
+                     help="Disable the python garbage collecter. Default is False.",
+                     action="store_true",
+                     dest="disable_gc",
+                     default=False)
+   parser.usage=usage_string
+
+   return parser
+   
 def run_ef_writer(options, args):
 
@@ -84 +98 @@
       risk_alpha = options.risk_alpha
 
-   write_ef_from_scratch(os.path.expanduser(options.model_directory), os.path.expanduser(options.instance_directory), os.path.expanduser(options.output_file), \
+   write_ef_from_scratch(os.path.expanduser(options.model_directory),
+                         os.path.expanduser(options.instance_directory),
+                         os.path.expanduser(options.output_file),
+                         options.verbose,
                          generate_weighted_cvar, cvar_weight, risk_alpha)
-
-   return
 
 def run(args=None):
@@ -96 +111 @@
     #
 
-    # for a one-pass execution, garbage collection doesn't make
-    # much sense - so I'm disabling it. Because: It drops the run-time
-    # by a factor of 3-4 on bigger instances.
-    gc.disable()       
-
     #
     # Parse command-line options.
     #
     try:
-       (options, args) = parser.parse_args(args=args)
+       options_parser = construct_ef_writer_options_parser("efwriter [options]")
+       (options, args) = options_parser.parse_args(args=args)
     except SystemExit:
        # the parser throws a system exit if "-h" is specified - catch
        # it to exit gracefully.
        return
+
+    if options.disable_gc is True:
+       gc.disable()
+    else:
+       gc.enable()
 
     if options.profile > 0:
@@ -140 +156 @@
 
     gc.enable()
+    
     return ans