Save switch version in the output directory for improved archiving, especially during active software development.

Author: josiahjohnston

switch_model/upgrade/manager.py

@@ -7,7 +7,7 @@
 import argparse
 import os
 import shutil
-from distutils.version import StrictVersion
+from pkg_resources import parse_version
 
 import switch_model
 
@@ -33,7 +33,7 @@
 # Not every code revision requires an update; this is the last revision that did.
 last_required_update = upgrade_plugins[-1][-1]
 
-code_version = StrictVersion(switch_model.__version__)
+code_version = parse_version(switch_model.__version__)
 version_file = 'switch_inputs_version.txt'
 #verbose = False
 verbose = True
@@ -91,7 +91,7 @@ def do_inputs_need_upgrade(inputs_dir):
     # Not every code revision requires an update, so just hard-code the last
     # revision that required an update.
     inputs_version = get_input_version(inputs_dir)
-    return StrictVersion(inputs_version) < StrictVersion(last_required_update)
+    return parse_version(inputs_version) < parse_version(last_required_update)
 
 
 def _backup(inputs_dir):
@@ -120,15 +120,15 @@ def upgrade_inputs(inputs_dir, backup=True, assign_current_version=False):
             _backup(inputs_dir)
         # Successively apply the upgrade scripts as needed.
         for (upgrader, v_from, v_to) in upgrade_plugins:
-            inputs_v = StrictVersion(get_input_version(inputs_dir))
+            inputs_v = parse_version(get_input_version(inputs_dir))
             # note: the next line catches datasets created by/for versions of Switch that
             # didn't require input directory upgrades
-            if StrictVersion(v_from) <= inputs_v < StrictVersion(v_to):
+            if parse_version(v_from) <= inputs_v < parse_version(v_to):
                 print_verbose('\tUpgrading from ' + v_from + ' to ' + v_to)
                 upgrader.upgrade_input_dir(inputs_dir)
         upgraded = True
 
-    if (StrictVersion(last_required_update) < StrictVersion(switch_model.__version__)
+    if (parse_version(last_required_update) < parse_version(switch_model.__version__)
             and assign_current_version):
         # user requested writing of current version number, even if no upgrade is needed
         # (useful for updating examples to track with new release of Switch)

switch_model/utilities.py

@@ -12,6 +12,8 @@
 from pyomo.environ import *
 import pyomo.opt
 
+import switch_model
+
 # Define string_types (same as six.string_types). This is useful for
 # distinguishing between strings and other iterables.
 try:
@@ -256,6 +258,12 @@ def post_solve(instance, outputs_dir=None):
         if hasattr(module, 'post_solve'):
             module.post_solve(instance, outputs_dir)
 
+    # Save the precise version used to solve this problem.
+    version_path = os.path.join(outputs_dir, 'software_version.txt')
+    with open(version_path, 'w') as f:
+        f.write("This problem was solved with switch version {}.{}".format(
+            switch_model.__version__, os.linesep))
+
 
 def min_data_check(model, *mandatory_model_components):
     """