Add feature for interactively exploring outputs from a previous model run.

Both the input and output datasets from a previous model run are loaded into a Switch model instance to allow interactive exploration. This enables using model Expressions, Sets and Variables to quickly produce new outputs or for quality control of solutions.
This feature was discussed in Pull Request #91 (#91).

Also, updates Copperplate0 example's outputs.
Added missing snippet to 2.0.0b1 upgrade script.

Author: bmaluenda

examples/copperplate0/outputs/DispatchBaseloadByPeriod.tab

@@ -0,0 +1,2 @@
+DispatchBaseloadByPeriod_index_1	DispatchBaseloadByPeriod_index_2	DispatchBaseloadByPeriod
+S-Geothermal	2020	0.5

examples/copperplate0/outputs/DispatchGen.tab

@@ -0,0 +1,7 @@
+GEN_TPS_1	GEN_TPS_2	DispatchGen
+S-Geothermal	2	0.5
+S-Geothermal	1	0.5
+S-NG_CC	1	6.9022
+S-NG_CC	2	0.0
+S-Central_PV-1	2	0.0
+S-Central_PV-1	1	0.5978

examples/copperplate0/outputs/GenFuelUseRate.tab

@@ -0,0 +1,3 @@
+GEN_TP_FUELS_1	GEN_TP_FUELS_2	GEN_TP_FUELS_3	GenFuelUseRate
+S-NG_CC	1	NaturalGas	46.279251
+S-NG_CC	2	NaturalGas	0.0

examples/copperplate0/outputs/dispatch.txt

@@ -1,3 +1,3 @@
 timestamp	S-Geothermal	S-NG_CC	S-Central_PV-1
-2025011512	0.96858075	6.43361925	0.5978
-2025011600	0.96858075	0.0	0.0
+2025011512	0.5	6.9022	0.5978
+2025011600	0.5	0	0

examples/copperplate0/outputs/gen_cap.txt

@@ -0,0 +1,4 @@
+GENERATION_PROJECT	PERIOD	GenCapacity	GenCapitalCosts	GenFixedOMCosts
+S-Central_PV-1	2020	1	227410	41850
+S-NG_CC	2020	7.34277	832743	43089.6
+S-Geothermal	2020	1	455992	0

examples/copperplate0/outputs/load_balance.txt

@@ -1,3 +1,3 @@
-load_zone	timestamp	LZ_NetDispatch	lz_demand_mw	DumpPower
-South	2025011512	8.0	8	0.0
-South	2025011600	0.96858075	0.5	0.46858075
+load_zone	timestamp	ZoneTotalCentralDispatch	ZoneTotalDistributedDispatch	zone_demand_mw
+South	2025011512	8	0	8
+South	2025011600	0.5	0	0.5

switch_model/solve.py

@@ -46,7 +46,8 @@ def debug(type, value, tb):
     parser = _ArgumentParser(allow_abbrev=False, add_help=False)
     add_module_args(parser)
     module_options = parser.parse_known_args(args=args)[0]
-    if do_inputs_need_upgrade(module_options.inputs_dir):
+    if(os.path.exists(module_options.inputs_dir) and
+       do_inputs_need_upgrade(module_options.inputs_dir)):
         do_upgrade = query_yes_no(
             ("Warning! Your inputs directory needs to be upgraded. "
              "Do you want to auto-upgrade now? We'll keep a backup of "
@@ -76,6 +77,10 @@ def debug(type, value, tb):
     if return_model and not return_instance:
         return model
 
+    if model.options.reload_prior_solution:
+        if not os.path.isdir(model.options.outputs_dir):
+            raise IOError("Specified outputs directory for solution exploration does not exist.")
+
     # get a list of modules to iterate through
     iterate_modules = get_iteration_list(model)
 
@@ -93,9 +98,9 @@ def debug(type, value, tb):
     # create an instance
     instance = model.load_inputs()
     instance.pre_solve()
+    instantiation_time = time.time()
     if model.options.verbose:
-        instantiation_time = time.time()
-        print "Inputs loaded in {:.2f} s.".format(instantiation_time - creation_time)
+        print "Inputs loaded in {:.2f} s.\n".format(instantiation_time - creation_time)
 
     # return the instance as-is if requested
     if return_instance:
@@ -104,49 +109,73 @@ def debug(type, value, tb):
         else:
             return instance
 
-    # make sure the outputs_dir exists (used by some modules during iterate)
-    # use a race-safe approach in case this code is run in parallel
-    try:
-        os.makedirs(instance.options.outputs_dir)
-    except OSError:
-        # directory probably exists already, but double-check
-        if not os.path.isdir(instance.options.outputs_dir):
-            raise
-
-    # solve the model
-    if iterate_modules:
-        if instance.options.verbose:
-            print "iterating model..."
-        iterate(instance, iterate_modules)
+    if model.options.reload_prior_solution:
+        # read variable values from previously solved model
+        import csv
+        var_objects = [c for c in instance.component_objects()
+            if isinstance(c,pyomo.core.base.Var)]
+        def _convert_if_numeric(s):
+            try:
+                return float(s)
+            except ValueError:
+                return s
+        for var in var_objects:
+            if '{}.tab'.format(var.name) not in os.listdir(model.options.outputs_dir):
+                raise RuntimeError("Tab output file for variable {} cannot be found in outputs directory. Exiting.".format(var.name))
+            with open(os.path.join(model.options.outputs_dir, '{}.tab'.format(var.name)),'r') as f:
+                reader = csv.reader(f, delimiter='\t')
+                # skip headers
+                next(reader)
+                for row in reader:
+                    index = (_convert_if_numeric(i) for i in row[:-1])
+                    var[index].value = float(row[-1])
+            print 'Loaded variable {} values into instance.'.format(var.name)
+        output_loading_time = time.time()
+        print 'Finished loading previous results into model instance in {:.2f} s.'.format(output_loading_time - instantiation_time)
     else:
-        results = solve(instance)
-        if instance.options.verbose:
-            print "Optimization termination condition was {}.\n".format(
-                results.solver.termination_condition)
-    
-    # report/save results
-    if instance.options.verbose:
-        post_solve_start_time = time.time()
-        print "Executing post solve functions..."
-    instance.post_solve()
-    if instance.options.verbose:
-        post_solve_end_time = time.time()
-        print "Post solve processing completed in {:.2f} s.".format(
-            post_solve_end_time - post_solve_start_time)
+        # make sure the outputs_dir exists (used by some modules during iterate)
+        # use a race-safe approach in case this code is run in parallel
+        try:
+            os.makedirs(model.options.outputs_dir)
+        except OSError:
+            # directory probably exists already, but double-check
+            if not os.path.isdir(model.options.outputs_dir):
+                raise
+
+        # solve the model
+        if iterate_modules:
+            if model.options.verbose:
+                print "Iterating model..."
+            iterate(instance, iterate_modules)
+        else:
+            results = solve(instance)
+            if model.options.verbose:
+                print "Optimization termination condition was {}.\n".format(
+                    results.solver.termination_condition)
+
+        # report/save results
+        if model.options.verbose:
+            post_solve_start_time = time.time()
+            print "Executing post solve functions..."
+        instance.post_solve()
+        if model.options.verbose:
+            post_solve_end_time = time.time()
+            print "Post solve processing completed in {:.2f} s.".format(
+                post_solve_end_time - post_solve_start_time)
 
     # return stdout to original
     sys.stdout = stdout_copy
 
-    if pre_module_options.interact:
+    if model.options.interact or model.options.reload_prior_solution:
         m = instance  # present the solved model as 'm' for convenience
         banner = (
             "\n"
-            "=================================================================================\n"
+            "=======================================================================\n"
             "Entering interactive Python shell.\n"
             "Abstract model is in 'model' variable; \n"
             "Solved instance is in 'instance' and 'm' variables.\n"
             "Type ctrl-d or exit() to exit shell.\n"
-            "=================================================================================\n"
+            "=======================================================================\n"
         )
         import code
         code.interact(banner=banner, local=dict(globals().items() + locals().items()))
@@ -331,6 +360,12 @@ def define_arguments(argparser):
     argparser.add_argument(
         '--verbose', '-v', default=False, action='store_true',
         help='Show information about model preparation and solution')
+    argparser.add_argument(
+        '--interact', default=False, action='store_true',
+        help='Enter interactive shell after solving the instance to enable inspection of the solved model.')
+    argparser.add_argument(
+        '--reload-prior-solution', default=False, action='store_true',
+        help='Load outputs from a previously solved instance into variable values to allow interactive exploration of model components without having to solve the instance again.')
 
 
 def add_module_args(parser):
@@ -362,8 +397,7 @@ def add_pre_module_args(parser):
                         help='Directory containing log files (default is "logs"')
     parser.add_argument("--debug", action="store_true", default=False,
                         help='Automatically start pdb debugger on exceptions')
-    parser.add_argument("--interact", action="store_true", default=False,
-                        help='Enter interactive shell after solving model (to inspect finished model).')
+
 
 def parse_pre_module_options(args):
     """
@@ -612,7 +646,6 @@ def query_yes_no(question, default="yes"):
                              "(or 'y' or 'n').\n")
 
 
-
 ###############
 
 if __name__ == "__main__":

switch_model/upgrade/upgrade_2_0_0b1.py

@@ -420,6 +420,9 @@ def update_cols_with_defaults(df, col_list):
         ],
         'zone_coincident_peak_demand.tab':[
         ('peak_demand_mw','zone_expected_coincident_peak_demand')
+        ],
+        'variable_capacity_factors.tab':[
+        ('proj_max_capacity_factor','gen_max_capacity_factor')
         ]
     }