Merge pull request Pyomo#2084 from Pyomo/finalize-release

Finalize release 6.1

Author: blnicho

.coin-or/projDesc.xml

@@ -227,8 +227,8 @@ Carl D. Laird, Chair, Pyomo Management Committee, cdlaird at sandia dot gov
 			     Use explicit overrides to disable use of automated
 			     version reporting.
 			-->
-			<stableVersionNumber>6.0.1</stableVersionNumber>
-			<releaseNumber>6.0.1</releaseNumber>
+			<stableVersionNumber>6.1</stableVersionNumber>
+			<releaseNumber>6.1</releaseNumber>
 
 		</developmentStatus>
 

CHANGELOG.txt

@@ -2,6 +2,68 @@
 Pyomo CHANGELOG
 ===============
 
+-------------------------------------------------------------------------------
+Pyomo 6.1    17 Aug 2021
+-------------------------------------------------------------------------------
+
+- General
+  - Support using TicTocTimer as a context manager (#2012)
+  - Add optional dependency target in setup.py (#2017)
+  - Added utilities for subsets of model components (#1998)
+  - Improvements in deprecation warning system (#2045, #2058, #2056)
+  - Resolve TeeStream deadlock issues (#2072)
+  - Move PYOMO_CONFIG_DIR into pyomo.common.envvar (#2065)
+  - Add a DynamicImplicitDomain domain validator (#2043)
+  - Generate standard repn misidentifies nonlinear expr (#2074)
+  - Add Module() validator to the config system (#2062)
+- Core
+  - Yield Iterator from IndexedComponent (#2007)
+  - Use yield from in pyomo.core (#1984)
+  - Improvements to sorted_robust and string formatting (#2020, #2024)
+  - Integrating numpy with the Pyomo expression system (#2027, #2034, #2070)
+  - Resolve Set bugs (#2048)
+  - Prevent attaching global Sets to Blocks (#2042)
+  - Correct scalar mutable param getitem implementation (#2066)
+  - Fix Var bounds with unitted mutable Params (#2067)
+  - Improve @disable_methods decorator (#2069)
+  - Allow native numeric types in relational expressions (#2073)
+  - Fixing symbol names in Initializer deprecation layer (#2079)
+  - Deprecate OrderedSet.__getitem__ in favor of OrderedSet.card() (#2053)
+- Documentation
+  - Create a list of related packages (#2016)
+- Solver Interfaces
+  - Clean up dependencies and solver.available() IO (#2011)
+  - Update Baron writer to recognize priority Suffix (#2035)
+  - Add OCTERACT to the list of known NEOS solvers (#2064)
+  - Resolve tee issues with Xpress 8.9+ (#2059)
+  - Increase timeout for ASL version request (#2083)
+- Testing
+  - Miscellaneous testing fixes (#2023)
+  - Improve management of tempfiles in tests (#2036)
+  - Update GHA to ubuntu-latest; resolve ampl/mp build error (#2015)
+  - Move constrained_layout tests to 'expensive' suite (#2018)
+  - Update xpress, appsi tests to manage CWD (#2031)
+  - Improve comparison of Book examples to baselines (#2044)
+  - Add retry/timeout to powershell downloads (#2077)
+- GDP Updates
+  - gdp.hull: Only create one disaggregated variable for all Disjuncts in
+    which a Var does not appear (#2005)
+- Contributed Packages
+  - FBBT: descend_into option for FBBT (#2025)
+  - FBBT: Interval arithmetic edge cases for FBBT (#2026)
+  - FBBT: Improved handling for product expressions (#2038)
+  - incidence_analysis: methods for generating and solving strongly
+    connected components of a square model (#2009)
+  - incidence_analysis: Add Dulmage-Mendelsohn partition (#2063)
+  - PETSc: Remove PETSc solver (#1986)
+  - PyROS: Pyomo Robust Optimization Solver (#2006, #2061)
+  - sensitivity_toolbox: Add kaug dsdp mode (#1613)
+  - APPSI: API Cleanup (#1944), bug-fix in update_variables (#2051)
+  - MindtPy: Increase code coverage (#2021)
+  - MindtPy: Replace is not by != (#2081)
+  - PyNumero: ExternalGreyBox subclass to embed implicit functions (#2022)
+
+
 -------------------------------------------------------------------------------
 Pyomo 6.0.1   4 Jun 2021
 -------------------------------------------------------------------------------

RELEASE.txt

@@ -1,4 +1,4 @@
-We are pleased to announce the release of Pyomo 6.0.1.
+We are pleased to announce the release of Pyomo 6.1.
 
 Pyomo is a collection of Python software packages that supports a
 diverse set of optimization capabilities for formulating and analyzing
@@ -9,18 +9,12 @@ The following are highlights of the 6.0 release series:
 
  - Improved stability and robustness of core Pyomo code and solver interfaces
  - Integration of Boolean variables into GDP
- - New packages: APPSI, structural model analysis, external grey box models
-
-Note: As a major release, Pyomo 6.0 has certain backwards
-incompatibilities with the 5.x series and the 2nd Edition of the Pyomo
-Book.  Most notably:
-
- - Removed support for Python 2.7 or 3.5
- - Moved PySP into a separate package at https://github.com/Pyomo/pysp
- - Renamed "Simple" components to "Scalar" components
- - Removed support for implicit ranged inequalities (a <= m.x <= b)
- - Removed support for component reconstruct method
- - Removed support for casting relational expressions to bool
+ - Integration of NumPy support into the Pyomo expression system
+ - New packages:
+    - APPSI (Auto-Persistent Pyomo Solver Interfaces)
+    - External grey box models
+    - PyROS (Pyomo Robust Optimization Solver)
+    - Structural model analysis
 
 A full list of updates and changes is available in the CHANGELOG.txt
 

pyomo/common/config.py

@@ -37,7 +37,7 @@
 
 relocated_module_attribute(
     'PYOMO_CONFIG_DIR', 'pyomo.common.envvar.PYOMO_CONFIG_DIR',
-    version='TBD')
+    version='6.1')
 
 USER_OPTION = 0
 ADVANCED_OPTION = 1

pyomo/contrib/sensitivity_toolbox/sens.py

@@ -34,7 +34,7 @@
 @deprecated("The sipopt function has been deprecated. Use the sensitivity_calculation() "
             "function with method='sipopt' to access this functionality.",
             logger='pyomo.contrib.sensitivity_toolbox',
-            version='TBD')
+            version='6.1')
 def sipopt(instance, paramSubList, perturbList,
            cloneModel=True, tee=False, keepfiles=False,
            streamSoln=False):
@@ -46,7 +46,7 @@ def sipopt(instance, paramSubList, perturbList,
 @deprecated("The kaug function has been deprecated. Use the sensitivity_calculation() "
             "function with method='k_aug' to access this functionality.", 
             logger='pyomo.contrib.sensitivity_toolbox',
-            version='TBD')
+            version='6.1')
 def kaug(instance, paramSubList, perturbList,
          cloneModel=True, tee=False, keepfiles=False, solver_options=None,
          streamSoln=False):

pyomo/core/base/PyomoModel.py

@@ -644,13 +644,15 @@ def create_instance( self, filename=None, data=None, name=None,
             kwds.pop('clone')
             deprecation_warning(
                 "Model.create_instance() no longer accepts the 'clone' "
-                "argument: the base abstract model is always cloned.")
+                "argument: the base abstract model is always cloned.",
+                version='5.4')
         if 'preprocess' in kwds:
             kwds.pop('preprocess')
             deprecation_warning(
                 "Model.create_instance() no longer accepts the preprocess' "
                 "argument: preprocessing is always deferred to when the "
-                "model is sent to the solver")
+                "model is sent to the solver",
+                version='5.4')
         if kwds:
             msg = \
 """Model.create_instance() passed the following unrecognized keyword
@@ -662,7 +664,8 @@ def create_instance( self, filename=None, data=None, name=None,
         if self.is_constructed():
             deprecation_warning(
                 "Cannot call Model.create_instance() on a constructed "
-                "model; returning a clone of the current model instance.")
+                "model; returning a clone of the current model instance.",
+                version='5.4')
             return self.clone()
 
         if report_timing:
@@ -735,7 +738,7 @@ def load(self, arg, namespaces=[None], profile_memory=0, report_timing=None):
             deprecation_warning(
                 "The report_timing argument to Model.load() is deprecated.  "
                 "Use pyomo.common.timing.report_timing() to enable reporting "
-                "construction timing")
+                "construction timing", version='5.4')
         if arg is None or isinstance(arg, str):
             dp = DataPortal(filename=arg, model=self)
         elif type(arg) is DataPortal:

pyomo/core/base/misc.py

@@ -21,10 +21,10 @@
 
 relocated_module_attribute(
     'tabular_writer', 'pyomo.common.formatting.tabular_writer',
-    version='TBD')
+    version='6.1')
 relocated_module_attribute(
     'sorted_robust', 'pyomo.common.sorting.sorted_robust',
-    version='TBD')
+    version='6.1')
 
 
 def display(obj, ostream=None):

pyomo/core/base/set.py

@@ -1381,7 +1381,7 @@ def __getitem__(self, key):
         deprecation_warning(
             "Using __getitem__ to return a set value from its (ordered) "
             "position is deprecated.  Please use card()",
-            version='TBD', remove_in='7.0')
+            version='6.1', remove_in='7.0')
         return self.card(key)
 
     def isordered(self):
@@ -1928,7 +1928,7 @@ def __init__(self, *args, **kwds):
         if 'virtual' in kwds:
             deprecation_warning(
                 "Pyomo Sets ignore the 'virtual' keyword argument",
-                logger='pyomo.core.base')
+                logger='pyomo.core.base', version='5.6.7')
             kwds.pop('virtual')
 
         IndexedComponent.__init__(self, *args, **kwds)

pyomo/core/base/util.py

@@ -18,16 +18,16 @@
 
 relocated_module_attribute(
     'disable_methods', 'pyomo.core.base.disable_methods.disable_methods',
-    version='TBD')
+    version='6.1')
 relocated_module_attribute(
     'Initializer', 'pyomo.core.base.initializer.Initializer',
-    version='TBD')
+    version='6.1')
 relocated_module_attribute(
     'IndexedCallInitializer', 'pyomo.core.base.initializer.Initializer',
-    version='TBD')
+    version='6.1')
 relocated_module_attribute(
     'CountedCallInitializer', 'pyomo.core.base.initializer.Initializer',
-    version='TBD')
+    version='6.1')
 
 def is_functor(obj):
     """

pyomo/core/expr/visitor.py

@@ -172,7 +172,8 @@ def __init__(self, **kwds):
                 deprecation_warning(
                     "Note that the API for the StreamBasedExpressionVisitor "
                     "has changed to include the child index for the %s() "
-                    "method.  Please update your walker callbacks." % (name,))
+                    "method.  Please update your walker callbacks." % (name,),
+                    version='5.7.0')
                 def wrap(fcn, nargs):
                     def wrapper(*args):
                         return fcn(*args[:nargs])

pyomo/core/kernel/register_numpy_types.py

@@ -12,7 +12,7 @@
 deprecation_warning(
     "pyomo.core.kernel.register_numpy_types is deprecated.  NumPy type "
     "registration is handled automatically by pyomo.common.dependencies.numpy",
-    version='TBD',
+    version='6.1',
 )
 
 from pyomo.core.expr.numvalue import (

pyomo/core/plugins/transform/add_slack_vars.py

@@ -21,12 +21,12 @@
 
 def target_list(x):
     deprecation_msg = ("In future releases ComponentUID targets will no "
-                      "longer be supported in the core.add_slack_variables "
-                      "transformation. Specify targets as a Constraint or "
-                      "list of Constraints.")
+                       "longer be supported in the core.add_slack_variables "
+                       "transformation. Specify targets as a Constraint or "
+                       "list of Constraints.")
     if isinstance(x, ComponentUID):
         if deprecation_msg:
-            deprecation_warning(deprecation_msg)
+            deprecation_warning(deprecation_msg, version='5.7.1')
             # only emit the message once
             deprecation_msg = None
         # [ESJ 07/15/2020] We have to just pass it through because we need the
@@ -39,7 +39,7 @@ def target_list(x):
         for i in x:
             if isinstance(i, ComponentUID):
                 if deprecation_msg:
-                    deprecation_warning(deprecation_msg)
+                    deprecation_warning(deprecation_msg, version='5.7.1')
                     deprecation_msg = None
                 # same as above...
                 ans.append(i)

pyomo/core/util.py

@@ -276,6 +276,9 @@ def sequence(*args):
 
 def xsequence(*args):
     from pyomo.common.deprecation import deprecation_warning
-    deprecation_warning("The xsequence function is deprecated.  Use the sequence() function, which returns a generator.")  # Remove in Pyomo 6.0
+    deprecation_warning(
+        "The xsequence function is deprecated.  Use the sequence() "
+        "function, which returns a generator.", version='5.5.1',
+        remove_in='6.0')
     return sequence(*args)
 

pyomo/version/info.py

@@ -24,10 +24,10 @@
 # should generally be left at 0, unless a downstream package is tracking
 # main and needs a hard reference to "suitably new" development.
 major=6
-minor=0
-micro=2
-releaselevel='invalid'
-#releaselevel='final'
+minor=1
+micro=0
+#releaselevel='invalid'
+releaselevel='final'
 serial=0
 
 if releaselevel == 'final':