Merge branch 'main' into fixNSGA2Bug

Author: ewu63

doc/install.rst

@@ -68,6 +68,12 @@ If you plan to modify pyOptSparse, installing with the developer option, i.e. wi
   Some optimizers are proprietary, and their sources are not distributed with pyOptSparse.
   To use them, please follow the instructions on specific optimizer pages.
 
+To see the list of installed optimizers, use the following:
+
+.. prompt:: bash
+
+  python -c "import pyoptsparse; print(pyoptsparse.list_optimizers())"
+
 Specifying compilers
 ~~~~~~~~~~~~~~~~~~~~
 To specify a non-default compiler (e.g. something other than ``/usr/bin/gcc``), meson recognizes certain `special environment variables <https://mesonbuild.com/Reference-tables.html#compiler-and-linker-selection-variables>`__.

pyoptsparse/__init__.py

@@ -6,7 +6,7 @@
 from .pyOpt_constraint import Constraint
 from .pyOpt_objective import Objective
 from .pyOpt_optimization import Optimization
-from .pyOpt_optimizer import Optimizer, OPT, Optimizers
+from .pyOpt_optimizer import Optimizer, OPT, Optimizers, list_optimizers
 from .pyOpt_solution import Solution
 
 # Now import all the individual optimizers

pyoptsparse/pyALPSO/pyALPSO.py

@@ -12,7 +12,6 @@
 
 # Local modules
 from . import alpso
-from ..pyOpt_error import Error
 from ..pyOpt_optimizer import Optimizer
 
 # isort: off
@@ -161,10 +160,10 @@ def objconfunc(x):
                 self.setOption("minInnerIter", opt("maxInnerIter"))
 
             if opt("stopCriteria") not in [0, 1]:
-                raise Error("Incorrect Stopping Criteria Setting")
+                raise ValueError("Incorrect Stopping Criteria Setting")
 
             if opt("fileout") not in [0, 1, 2, 3]:
-                raise Error("Incorrect fileout Setting")
+                raise ValueError("Incorrect fileout Setting")
 
             # Run ALPSO
             t0 = time.time()

pyoptsparse/pyCONMIN/pyCONMIN.py

@@ -12,7 +12,6 @@
 import numpy as np
 
 # Local modules
-from ..pyOpt_error import Error
 from ..pyOpt_optimizer import Optimizer
 from ..pyOpt_utils import try_import_compiled_module_from_path
 
@@ -194,7 +193,7 @@ def cnmngrad(n1, n2, x, f, g, ct, df, a, ic, nac):
             if self.getOption("IPRINT") >= 0 and self.getOption("IPRINT") <= 4:
                 iprint = self.getOption("IPRINT")
             else:
-                raise Error("IPRINT option must be >= 0 and <= 4")
+                raise ValueError("IPRINT option must be >= 0 and <= 4")
 
             iout = self.getOption("IOUT")
             ifile = self.getOption("IFILE")

pyoptsparse/pyNLPQLP/pyNLPQLP.py

@@ -2,6 +2,7 @@
 pyNLPQLP - A pyOptSparse wrapper for Schittkowski's NLPQLP
 optimization algorithm.
 """
+
 # Standard Python modules
 import datetime
 import os
@@ -11,7 +12,6 @@
 import numpy as np
 
 # Local modules
-from ..pyOpt_error import Error
 from ..pyOpt_optimizer import Optimizer
 from ..pyOpt_utils import try_import_compiled_module_from_path
 
@@ -225,10 +225,10 @@ def nlgrad(m, me, mmax, n, f, g, df, dg, x, active, wa):
             d = np.zeros(nmax)
             go = self.getOption
             if go("iPrint") < 0 or go("iPrint") > 4:
-                raise Error("Incorrect iPrint option. Must be >=0 and <= 4")
+                raise ValueError("Incorrect iPrint option. Must be >=0 and <= 4")
 
             if not (go("mode") >= 0 and go("mode") <= 18):
-                raise Error("Incorrect mode option. Must be >= 0 and <= 18.")
+                raise ValueError("Incorrect mode option. Must be >= 0 and <= 18.")
 
             if os.path.isfile(go("iFile")):
                 os.remove(go("iFile"))

pyoptsparse/pyNSGA2/pyNSGA2.py

@@ -11,7 +11,6 @@
 import numpy as np
 
 # Local modules
-from ..pyOpt_error import Error
 from ..pyOpt_optimizer import Optimizer
 from ..pyOpt_utils import try_import_compiled_module_from_path
 
@@ -161,7 +160,7 @@ def objconfunc(nreal, nobj, ncon, x, f, g):
             if self.getOption("PrintOut") >= 0 and self.getOption("PrintOut") <= 2:
                 printout = self.getOption("PrintOut")
             else:
-                raise Error("Incorrect option PrintOut")
+                raise ValueError("Incorrect option PrintOut")
 
             seed = self.getOption("seed")
             if seed == 0:

pyoptsparse/pyOpt_constraint.py

@@ -7,7 +7,7 @@
 import numpy as np
 
 # Local modules
-from .pyOpt_error import Error, pyOptSparseWarning
+from .pyOpt_error import pyOptSparseWarning
 from .pyOpt_types import Dict1DType
 from .pyOpt_utils import INFINITY, _broadcast_to_array, convertToCOO
 
@@ -204,7 +204,7 @@ def finalize(self, variables: OrderedDict, dvOffset, index: int):
                 try:
                     self.wrt = list(self.wrt)
                 except Exception:
-                    raise Error(f"The 'wrt' argument to constraint '{self.name}' must be an iterable list")
+                    raise TypeError(f"The 'wrt' argument to constraint '{self.name}' must be an iterable list")
 
             # We allow 'None' to be in the list...they are null so
             # just pop them out:
@@ -214,7 +214,7 @@ def finalize(self, variables: OrderedDict, dvOffset, index: int):
             # *actually* are variables
             for dvGroup in self.wrt:
                 if dvGroup not in variables:
-                    raise Error(
+                    raise KeyError(
                         f"The supplied dvGroup '{dvGroup}' in 'wrt' for the {self.name} constraint, does not exist. "
                         + "It must be added with a call to addVar() or addVarGroup()."
                     )
@@ -254,7 +254,7 @@ def finalize(self, variables: OrderedDict, dvOffset, index: int):
             # sparse constraints.
 
             if self.linear:
-                raise Error(
+                raise ValueError(
                     "The 'jac' keyword to argument to addConGroup() must be supplied for a linear constraint. "
                     + f"The constraint in error is {self.name}."
                 )
@@ -274,7 +274,7 @@ def finalize(self, variables: OrderedDict, dvOffset, index: int):
         else:
             # First sanitize input:
             if not isinstance(self.jac, dict):
-                raise Error(
+                raise TypeError(
                     "The 'jac' keyword argument to addConGroup() must be a dictionary. "
                     + f"The constraint in error is {self.name}."
                 )
@@ -301,7 +301,7 @@ def finalize(self, variables: OrderedDict, dvOffset, index: int):
 
                 # Generically check the shape:
                 if self.jac[dvGroup]["shape"][0] != self.ncon or self.jac[dvGroup]["shape"][1] != ndvs:
-                    raise Error(
+                    raise ValueError(
                         f"The supplied Jacobian for dvGroup {dvGroup}' in constraint {self.name}, was the incorrect size. "
                         + f"Expecting a Jacobian of size ({self.ncon}, {ndvs}) but received a Jacobian of size "
                         + f"({self.jac[dvGroup]['shape'][0]}, {self.jac[dvGroup]['shape'][1]})."

pyoptsparse/pyOpt_error.py

@@ -5,31 +5,6 @@
 """
 
 
-class Error(Exception):
-    """
-    Format the error message in a box to make it clear this
-    was a expliclty raised exception.
-    """
-
-    def __init__(self, message):
-        msg = "\n+" + "-" * 78 + "+" + "\n" + "| pyOptSparse Error: "
-        i = 21
-        for word in message.split():
-            if len(word) + i + 1 > 78:  # Finish line and start new one
-                msg += " " * (79 - i) + "|\n| " + word + " "
-                i = 2 + len(word) + 1
-            else:
-                msg += word + " "
-                i += len(word) + 1
-        msg += " " * (79 - i) + "|\n" + "+" + "-" * 78 + "+" + "\n"
-        print(msg)
-        self.message = message
-        super().__init__(message)
-
-    def __str__(self):
-        return self.message
-
-
 class pyOptSparseWarning:
     """
     Format a warning message

pyoptsparse/pyOpt_history.py

@@ -8,7 +8,7 @@
 from sqlitedict import SqliteDict
 
 # Local modules
-from .pyOpt_error import Error, pyOptSparseWarning
+from .pyOpt_error import pyOptSparseWarning
 from .pyOpt_utils import EPS
 
 
@@ -53,7 +53,7 @@ def __init__(self, fileName, optProb=None, temp=False, flag="r"):
                 )
             self._processDB()
         else:
-            raise Error("The flag argument to History must be 'r' or 'n'.")
+            raise ValueError("The flag argument to History must be 'r' or 'n'.")
         self.temp = temp
         self.fileName = fileName
 
@@ -578,7 +578,7 @@ def getValues(self, names=None, callCounters=None, major=True, scale=False, stac
             allNames.add("xuser")
         # error if names isn't either a DV, con or obj
         if not names.issubset(allNames):
-            raise Error(
+            raise KeyError(
                 "The names provided are not one of DVNames, conNames or objNames.\n"
                 + f"The names must be a subset of {allNames}"
             )