Merge branch 'main' into add_cuopt_direct_solver_plugin

Author: jsiirola

.github/workflows/release_wheel_creation.yml

@@ -59,17 +59,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Create pyproject.toml
-        run: |
-          # Per the cibuildwheel documentation, you can technically use
-          # CIBW_BEFORE_BUILD to do these steps; however, as of the newest
-          # version (2.21.3) this feature does not work. This is a hack
-          # to make cibuildwheel recognize our pre-build requirements
-          echo -e '[build-system]\n\nrequires = [ "setuptools", "wheel", "cython", "pybind11" ]' > $GITHUB_WORKSPACE/pyproject.toml
-          cat $GITHUB_WORKSPACE/pyproject.toml
-          ls -la $GITHUB_WORKSPACE
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.21.3
+        uses: pypa/cibuildwheel@main
         with:
           output-dir: dist
         env:
@@ -118,17 +109,8 @@ jobs:
         uses: docker/setup-qemu-action@v3
         with:
           platforms: all
-      - name: Create pyproject.toml
-        run: |
-          # Per the cibuildwheel documentation, you can technically use
-          # CIBW_BEFORE_BUILD to do these steps; however, as of the newest
-          # version (2.21.3) this feature does not work. This is a hack
-          # to make cibuildwheel recognize our pre-build requirements
-          echo -e '[build-system]\n\nrequires = [ "setuptools", "wheel", "cython", "pybind11" ]' > $GITHUB_WORKSPACE/pyproject.toml
-          cat $GITHUB_WORKSPACE/pyproject.toml
-          ls -la $GITHUB_WORKSPACE
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.21.3
+        uses: pypa/cibuildwheel@main
         with:
           output-dir: dist
         env:
@@ -158,10 +140,11 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install twine wheel setuptools pybind11
+          pip install build twine wheel setuptools pybind11
       - name: Build pure python wheel
         run: |
-          python setup.py --without-cython sdist --format=gztar bdist_wheel
+          export PYOMO_SETUP_ARGS=--without-cython
+          python -m build --wheel --outdir dist --config-setting="--build-option=--without-cython"
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
@@ -189,10 +172,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install twine wheel setuptools pybind11
+        pip install build twine wheel 'setuptools>=65' pybind11
     - name: Build generic tarball
       run: |
-        python setup.py --without-cython sdist --format=gztar
+        export PYOMO_SETUP_ARGS=--without-cython
+        python -m build --sdist --outdir dist --config-setting="--build-option=--without-cython"
     - name: Upload artifact
       uses: actions/upload-artifact@v4
       with:

.github/workflows/test_branches.yml

@@ -76,13 +76,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python: [3.13]
+        python: ['3.13.3']  # FIXME: Remove specific 3.13 version once logging tests are fixed
         other: [""]
         category: [""]
 
         include:
         - os: ubuntu-latest
-          python: 3.13
+          python: '3.13.3'  # FIXME: Remove specific 3.13 version once logging tests are fixed
           test_docs: 1
           TARGET: linux
           PYENV: pip
@@ -348,7 +348,7 @@ jobs:
         if test "${{matrix.TARGET}}" == linux; then
             EXCLUDE="casadi numdifftools $EXCLUDE"
         fi
-        if [[ "${{matrix.TARGET}}" == win && "${{matrix.python}}" == "3.13" ]]; then
+        if [[ "${{matrix.TARGET}}" == win && "${{matrix.python}}" == 3.13* ]]; then
             # As of Nov 7, 2024, qtconsole is not compatible with python 3.13 on win
             EXCLUDE="qtconsole $EXCLUDE"
         fi
@@ -373,7 +373,7 @@ jobs:
         fi
         # Note: this will fail the build if any installation fails (or
         # possibly if it outputs messages to stderr)
-        conda install --update-deps -q -y $CONDA_DEPENDENCIES
+        conda install --update-deps -q -y python="${{matrix.python}}" $CONDA_DEPENDENCIES
         if test -z "${{matrix.slim}}"; then
             # xpress.init() (xpress 9.5.1 from conda) hangs indefinitely
             # on GHA/Windows under Python 3.10 and 3.11.  Exclude that
@@ -654,14 +654,15 @@ jobs:
 
     - name: Install Pyomo
       run: |
+        export PYOMO_SETUP_ARGS=${{ matrix.setup_options }}
         echo ""
         echo "Clone Pyomo-model-libraries..."
         URL=https://github.com/Pyomo/pyomo-model-libraries.git
         git clone -b ${SRC_REF##*/} $URL || git clone -b main $URL
         echo ""
         echo "Install Pyomo..."
         echo ""
-        $PYTHON_EXE setup.py develop ${{matrix.setup_options}}
+        $PYTHON_EXE -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""
@@ -790,7 +791,7 @@ jobs:
         echo ""
         echo "Install Pyomo..."
         echo ""
-        python setup.py develop
+        python -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""
@@ -868,13 +869,14 @@ jobs:
 
     - name: Install Pyomo
       run: |
+        export PYOMO_SETUP_ARGS=${{ matrix.setup_options }}
         echo ""
         echo "Clone Pyomo-model-libraries..."
         git clone https://github.com/Pyomo/pyomo-model-libraries.git
         echo ""
         echo "Install Pyomo..."
         echo ""
-        $PYTHON_EXE setup.py develop ${{matrix.setup_options}}
+        $PYTHON_EXE -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""

.github/workflows/test_pr_and_main.yml

@@ -88,7 +88,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: [ 3.9, '3.10', 3.11, 3.12, 3.13 ]
+        python: [ 3.9, '3.10', 3.11, 3.12, '3.13.3' ]  # FIXME: Remove specific 3.13 version once logging tests are fixed
         other: [""]
         category: [""]
 
@@ -400,7 +400,7 @@ jobs:
         if test "${{matrix.TARGET}}" == linux; then
             EXCLUDE="casadi numdifftools $EXCLUDE"
         fi
-        if [[ "${{matrix.TARGET}}" == win && "${{matrix.python}}" == "3.13" ]]; then
+        if [[ "${{matrix.TARGET}}" == win && "${{matrix.python}}" == 3.13* ]]; then
             # As of Nov 7, 2024, qtconsole is not compatible with python 3.13 on win
             EXCLUDE="qtconsole $EXCLUDE"
         fi
@@ -425,7 +425,7 @@ jobs:
         fi
         # Note: this will fail the build if any installation fails (or
         # possibly if it outputs messages to stderr)
-        conda install --update-deps -q -y $CONDA_DEPENDENCIES
+        conda install --update-deps -q -y python="${{matrix.python}}" $CONDA_DEPENDENCIES
         if test -z "${{matrix.slim}}"; then
             # xpress.init() (xpress 9.5.1 from conda) hangs indefinitely
             # on GHA/Windows under Python 3.10 and 3.11.  Exclude that
@@ -706,14 +706,15 @@ jobs:
 
     - name: Install Pyomo
       run: |
+        export PYOMO_SETUP_ARGS=${{ matrix.setup_options }}
         echo ""
         echo "Clone Pyomo-model-libraries..."
         URL=https://github.com/Pyomo/pyomo-model-libraries.git
         git clone -b ${SRC_REF##*/} $URL || git clone -b main $URL
         echo ""
         echo "Install Pyomo..."
         echo ""
-        $PYTHON_EXE setup.py develop ${{matrix.setup_options}}
+        $PYTHON_EXE -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""
@@ -843,7 +844,7 @@ jobs:
         echo ""
         echo "Install Pyomo..."
         echo ""
-        python setup.py develop
+        python -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""
@@ -921,13 +922,14 @@ jobs:
 
     - name: Install Pyomo
       run: |
+        export PYOMO_SETUP_ARGS=${{ matrix.setup_options }}
         echo ""
         echo "Clone Pyomo-model-libraries..."
         git clone https://github.com/Pyomo/pyomo-model-libraries.git
         echo ""
         echo "Install Pyomo..."
         echo ""
-        $PYTHON_EXE setup.py develop ${{matrix.setup_options}}
+        $PYTHON_EXE -m pip install -e .
         echo ""
         echo "Set custom PYOMO_CONFIG_DIR"
         echo ""

.github/workflows/typos.toml

@@ -71,4 +71,6 @@ EOF = "EOF"
 lst = "lst"
 # Abbreviation of gamma (used in stochpdegas1_automatic.py)
 gam = "gam"
+# Regex search term from contrib/solver/solvers/ipopt
+ond = "ond"
 # AS NEEDED: Add More Words Below

.jenkins.sh

@@ -28,7 +28,7 @@
 #
 # DISABLE_COVERAGE: if nonempty, then coverage analysis is disabled
 #
-# PYOMO_SETUP_ARGS: passed to the 'python setup.py develop' command
+# PYOMO_SETUP_ARGS: passed to the 'pip install' command
 #     (e.g., to specify --with-cython)
 #
 # PYOMO_DOWNLOAD_ARGS: passed to the 'pyomo download-extensions' command
@@ -94,7 +94,7 @@ if test -z "$MODE" -o "$MODE" == setup; then
         echo "PyUtilib not found; skipping"
     fi
     pushd "$WORKSPACE/pyomo" || exit 1
-    python setup.py develop $PYOMO_SETUP_ARGS || exit 1
+    pip install -e . || exit 1
     popd
     #
     # DO NOT install pyomo-model-libraries

doc/OnlineDocs/explanation/analysis/parmest/installation.rst

@@ -21,7 +21,7 @@ Python package dependencies
 IPOPT
 -----
 
-IPOPT can be downloaded from https://projects.coin-or.org/Ipopt. 
+The IPOPT project homepage is https://github.com/coin-or/Ipopt
 
 Testing
 -------

doc/OnlineDocs/explanation/analysis/sensitivity_toolbox.rst

@@ -3,7 +3,7 @@ Sensitivity Toolbox
 
 The sensitivity toolbox provides a Pyomo interface to sIPOPT and k_aug to very quickly compute approximate solutions to nonlinear programs with a small perturbation in model parameters.
 
-See the `sIPOPT documentation <https://projects.coin-or.org/Ipopt/wiki/sIpopt>`_ or the `following paper <https://link.springer.com/article/10.1007/s12532-012-0043-2>`_ for additional details:
+See the `sIPOPT documentation <https://coin-or.github.io/Ipopt/SPECIALS.html#SIPOPT>`_ or the `following paper <https://link.springer.com/article/10.1007/s12532-012-0043-2>`_ for additional details:
 
   H. Pirnay, R. Lopez-Negrete, and L.T. Biegler, Optimal Sensitivity based on IPOPT, Math. Prog. Comp., 4(4):307--331, 2012.
 
@@ -185,7 +185,7 @@ Installing sIPOPT and k_aug
 The sensitivity toolbox requires either sIPOPT or k_aug to be installed and available in your system PATH. See the sIPOPT and k_aug documentation for detailed instructions:
 
 * https://coin-or.github.io/Ipopt/INSTALL.html
-* https://projects.coin-or.org/Ipopt/wiki/sIpopt
+* https://coin-or.github.io/Ipopt/SPECIALS.html#SIPOPT
 * https://coin-or.github.io/coinbrew/
 * https://github.com/dthierry/k_aug
 

doc/OnlineDocs/explanation/experimental/solvers.rst

@@ -386,3 +386,109 @@ implemented. For example, for ``ipopt``:
    :members:
    :show-inheritance:
    :inherited-members:
+
+
+Dual Sign Convention
+--------------------
+For all future solver interfaces, Pyomo adopts the following sign convention. Given the problem
+
+.. math::
+
+   \begin{aligned}
+   \min\quad      & f(x) \\
+   \text{s.t.}\quad & c_i(x) = 0 \quad \forall i \in \mathcal{E} \\
+                    & g_i(x) \le 0 \quad \forall i \in \mathcal{U} \\
+                    & h_i(x) \ge 0 \quad \forall i \in \mathcal{L}
+   \end{aligned}
+
+We define the Lagrangian as
+
+.. math::
+
+   \begin{aligned}
+   L(x, \lambda, \nu, \delta)
+     &= f(x)
+        - \sum_{i \in \mathcal{E}} \lambda_i\,c_i(x)
+        - \sum_{i \in \mathcal{U}} \nu_i\,g_i(x)
+        - \sum_{i \in \mathcal{L}} \delta_i\,h_i(x)
+   \end{aligned}
+
+Then, the KKT conditions are [NW99]_
+
+.. math::
+
+   \begin{aligned}
+   \nabla_x L(x, \lambda, \nu, \delta) &= 0 \\
+   c(x)                                &= 0 \\
+   g(x)                                &\le 0 \\
+   h(x)                                &\ge 0 \\
+   \nu                                 &\le 0 \\
+   \delta                              &\ge 0 \\
+   \nu_i\,g_i(x)                       &= 0 \\
+   \delta_i\,h_i(x)                    &= 0
+   \end{aligned}
+
+Note that this sign convention is based on the ``(lower, body, upper)``
+representation of constraints rather than the expression provided by a
+user. Users can specify constraints with variables on both the left- and
+right-hand sides of equalities and inequalities. However, the
+``(lower, body, upper)`` representation ensures that all variables
+appear in the ``body``, matching the form of the problem above.
+
+For maximization problems of the form
+
+.. math::
+
+   \begin{aligned}
+   \max\quad      & f(x) \\
+   \text{s.t.}\quad & c_i(x) = 0 \quad \forall i \in \mathcal{E} \\
+                    & g_i(x) \le 0 \quad \forall i \in \mathcal{U} \\
+                    & h_i(x) \ge 0 \quad \forall i \in \mathcal{L}
+   \end{aligned}
+
+we define the Lagrangian to be the same as above:
+
+.. math::
+
+   \begin{aligned}
+   L(x, \lambda, \nu, \delta)
+     &= f(x)
+        - \sum_{i \in \mathcal{E}} \lambda_i\,c_i(x)
+        - \sum_{i \in \mathcal{U}} \nu_i\,g_i(x)
+        - \sum_{i \in \mathcal{L}} \delta_i\,h_i(x)
+   \end{aligned}
+
+As a result, the signs of the duals change. The KKT conditions are 
+
+.. math::
+
+   \begin{aligned}
+   \nabla_x L(x, \lambda, \nu, \delta) &= 0 \\
+   c(x)                                &= 0 \\
+   g(x)                                &\le 0 \\
+   h(x)                                &\ge 0 \\
+   \nu                                 &\ge 0 \\
+   \delta                              &\le 0 \\
+   \nu_i\,g_i(x)                       &= 0 \\
+   \delta_i\,h_i(x)                    &= 0
+   \end{aligned}
+
+
+Pyomo also supports "range constraints" which are inequalities with both upper
+and lower bounds, where the bounds are not equal. For example,
+
+.. math::
+
+   -1 \leq x + y \leq 1
+
+These are handled very similarly to variable bounds in terms of dual sign
+conventions. For these, at most one "side" of the inequality can be active
+at a time. If neither side is active, then the dual will be zero. If the dual
+is nonzero, then the dual corresponds to the side of the constraint that is
+active. The dual for the other side will be implicitly zero. When accessing
+duals, the keys are the constraints. As a result, there is only one key for
+a range constraint, even though it is really two constraints. Therefore, the
+dual for the inactive side will not be reported explicitly. Again, the sign
+convention is based on the ``(lower, body, upper)`` representation of the
+constraint. Therefore, the left side of this inequality belongs to
+:math:`\mathcal{L}` and the right side belongs to :math:`\mathcal{U}`.