Changes suggested by Miranda

doc/OnlineDocs/contributed_packages/iis.rst

@@ -28,7 +28,7 @@ solver uses, so users may want to post-process output if it is going
 to be used for analysis. It also computes a minimal intractable system
 (which is not guaranteed to be unique).  It was written by Ben Knueven
 as part of the watertap project and is governed by a license shown
-at the bottom of the ``mis.py``.
+at the top of ``mis.py``.
 
 The algorithms come from John Chinneck's slides, see: https://www.sce.carleton.ca/faculty/chinneck/docs/CPAIOR07InfeasibilityTutorial.pdf
 
@@ -54,9 +54,8 @@ this help file, which references a Pyomo model with the Python variable
    This is done instead of solving the problem.
 
 .. Note::
-   If IDAES is installed, the `solver` keyword argument
-   is not needed (the function will use IDAES to find
-   a solver).
+   IDAES users can pass ``get_solver()`` imported from ``ideas.core.solvers``
+   as the solver.
 
 Interpreting the Output
 -----------------------

pyomo/contrib/iis/mis.py

@@ -1,8 +1,33 @@
+#  ___________________________________________________________________________
+#
+#  Pyomo: Python Optimization Modeling Objects
+#  Copyright (c) 2008-2024
+#  National Technology and Engineering Solutions of Sandia, LLC
+#  Under the terms of Contract DE-NA0003525 with National Technology and
+#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain
+#  rights in this software.
+#  This software is distributed under the 3-clause BSD License.
+#  ___________________________________________________________________________
+"""
+WaterTAP Copyright (c) 2020-2023, The Regents of the University of California, through Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, National Renewable Energy Laboratory, and National Energy Technology Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+    Neither the name of the University of California, Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, National Renewable Energy Laboratory, National Energy Technology Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.
+"""
 """
 Minimal Intractable System (MIS) finder
 Originally written by Ben Knueven as part of the WaterTAP project:
    https://github.com/watertap-org/watertap
-That's why DLW put a huge license notice at the bottom of this file.
+That's why this file has the watertap copyright notice.
 
 copied by DLW 18Feb2024 and edited
 
@@ -21,13 +46,6 @@
 
 from pyomo.opt import WriterFactory
 
-try:
-    from idaes.core.solvers import get_solver
-
-    have_idaes = True
-except:
-    have_idaes = False
-
 logger = logging.getLogger("pyomo.contrib.iis")
 logger.setLevel(logging.INFO)
 
@@ -100,10 +118,7 @@ def compute_infeasibility_explanation(
     modified_model = model.clone()
 
     if solver is None:
-        if have_idaes:
-            solver = get_solver()
-        else:
-            raise ValueError("solver needed unless IDAES is installed")
+        raise ValueError("A solver must be supplied")
     elif isinstance(solver, str):
         solver = pyo.SolverFactory(solver)
     else:
@@ -283,12 +298,11 @@ def _constraint_generator():
             constr.deactivate()
             for var, val in _modified_model_value_cache.items():
                 var.set_value(val, skip_validation=True)
+            math_failure = False
             try:
                 results = solver.solve(modified_model, tee=tee)
             except:
                 math_failure = True
-            else:
-                math_failure = False
 
             if math_failure:
                 constr.activate()
@@ -363,20 +377,3 @@ def _get_constraint(modified_model, v):
         return constr
     else:
         raise RuntimeError("Bad var name {v.name}")
-
-
-"""
-WaterTAP Copyright (c) 2020-2023, The Regents of the University of California, through Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, National Renewable Energy Laboratory, and National Energy Technology Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-    Neither the name of the University of California, Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, National Renewable Energy Laboratory, National Energy Technology Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.
-"""

pyomo/contrib/iis/tests/trivial_mis.py

@@ -1,3 +1,13 @@
+#  ___________________________________________________________________________
+#
+#  Pyomo: Python Optimization Modeling Objects
+#  Copyright (c) 2008-2024
+#  National Technology and Engineering Solutions of Sandia, LLC
+#  Under the terms of Contract DE-NA0003525 with National Technology and
+#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain
+#  rights in this software.
+#  This software is distributed under the 3-clause BSD License.
+#  ___________________________________________________________________________
 import pyomo.environ as pyo
 
 m = pyo.ConcreteModel("Trivial Quad")
@@ -8,8 +18,7 @@
 
 from pyomo.contrib.iis.mis import compute_infeasibility_explanation
 
-# if IDAES is installed, compute_infeasibility_explanation doesn't need to be passed a solver
 # Note: this particular little problem is quadratic
-# As of 18Feb DLW is not sure the explanation code works with solvers other than ipopt
+# As of 18Feb2024 DLW is not sure the explanation code works with solvers other than ipopt
 ipopt = pyo.SolverFactory("ipopt")
 compute_infeasibility_explanation(m, solver=ipopt)