Merge branch 'scipopt:master' into build

Author: Zeroto521

.github/workflows/build_wheels.yml

@@ -28,9 +28,11 @@ jobs:
         include:
           - os: ubuntu-22.04
             arch: x86_64
+          - os: ubuntu-24.04-arm
+            arch: aarch64
           - os: macos-14
             arch: arm64
-          - os: macos-13
+          - os: macos-15-intel
             arch: x86_64
           - os: windows-latest
             arch: AMD64
@@ -39,15 +41,14 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-    
+
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.21.1
+        uses: pypa/cibuildwheel@v3.2.1
         env:
           CIBW_ARCHS: ${{ matrix.arch }}
-          CIBW_TEST_GROUPS: test
+          CIBW_BEFORE_TEST: "pip install -r {project}/requirements/test.txt"
           CIBW_TEST_COMMAND: "pytest {project}/tests"
-          CIBW_MANYLINUX_*_IMAGE: manylinux_2_28
-        
+
       - uses: actions/upload-artifact@v4
         with:
           name: wheels-${{ matrix.os}}-${{ matrix.arch }}
@@ -100,4 +101,3 @@ jobs:
           user: __token__
           password: ${{ secrets.TESTPYPI_API_TOKEN }}
           verbose: true
-

.github/workflows/coverage.yml

@@ -1,6 +1,6 @@
 name: Run tests with coverage
 env:
-  version: 9.2.3
+  version: 10.0.0
 
 on:
   push:
@@ -25,8 +25,8 @@ jobs:
 
       - name: Install dependencies (SCIPOptSuite)
         run: |
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Linux-ubuntu22.deb
-          sudo apt-get update && sudo apt install -y ./SCIPOptSuite-${{ env.version }}-Linux-ubuntu22.deb
+          wget --quiet --no-check-certificate "https://github.com/scipopt/scip/releases/download/v${{ env.version }}/scipoptsuite_${{ env.version }}-1+jammy_amd64.deb"
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
 
       - name: Setup python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -40,7 +40,7 @@ jobs:
 
       - name: Install PySCIPOpt
         run: |
-          export CFLAGS="-O0 -ggdb -Wall -Wextra -Werror" # Debug mode. More warnings. Warnings as errors.
+          export CFLAGS="-O0 -ggdb -Wall -Wextra -Werror -Wno-error=deprecated-declarations" # Debug mode. More warnings. Warnings as errors, but allow deprecated declarations.
           python -m pip install . -v 2>&1 | tee build.log
           grep -i "warning" build.log || true
 

.github/workflows/integration-test.yml

@@ -1,7 +1,7 @@
 name: Integration test
 
 env:
-  version: 9.2.3
+  version: 10.0.0
 
 on:
   push:
@@ -23,8 +23,8 @@ jobs:
 
       - name: Install dependencies (SCIPOptSuite)
         run: |
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Linux-ubuntu22.deb
-          sudo apt-get update && sudo apt install -y ./SCIPOptSuite-${{ env.version }}-Linux-ubuntu22.deb
+          wget --quiet --no-check-certificate "https://github.com/scipopt/scip/releases/download/v${version}/scipoptsuite_${version}-1+jammy_amd64.deb"
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${version}-1+jammy_amd64.deb
 
       - name: Setup python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -54,8 +54,11 @@ jobs:
 
       - name: Download dependencies (SCIPOptSuite)
         shell: powershell
-        run: wget https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-win64.exe -outfile scipopt-installer.exe
-
+        run: |
+          $v = "${{ env.version }}"
+          $url = "https://github.com/scipopt/scip/releases/download/v$($v)/scipoptsuite-$($v)-win-x64.exe"
+          Write-Host "Downloading $url"
+          Invoke-WebRequest -Uri $url -OutFile scipopt-installer.exe
       - name: Install dependencies (SCIPOptSuite)
         shell: cmd
         run: scipopt-installer.exe /S /D=${{ env.SCIPOPTDIR }}
@@ -92,10 +95,16 @@ jobs:
       - name: Install dependencies (SCIPOptSuite)
         run: |
           brew install tbb boost bison
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Darwin.sh
-          chmod +x SCIPOptSuite-${{ env.version }}-Darwin.sh
-          ./SCIPOptSuite-${{ env.version }}-Darwin.sh --skip-license --include-subdir
-          mv SCIPOptSuite-${{ env.version }}-Darwin ${{ github.workspace }}/scipoptsuite
+          echo 'export PATH="/opt/homebrew/opt/bison/bin:$PATH"' >> $HOME/.bash_profile
+          echo 'export LDFLAGS="-L/opt/homebrew/opt/bison/lib"' >> $HOME/.bash_profile
+          source $HOME/.bash_profile
+          v="${version}"
+          url="https://github.com/scipopt/scip/releases/download/v${v}/scipoptsuite-${v}-macos13-arm64.tgz"
+          echo "Downloading ${url}"
+          curl -L -o scipoptsuite.tgz "${url}"
+          mkdir -p "${{ github.workspace }}/scipoptsuite"
+          tar -xzf scipoptsuite.tgz -C "${{ github.workspace }}/scipoptsuite" --strip-components=1
+          ls -la "${{ github.workspace }}/scipoptsuite"
 
       - name: Setup python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -122,4 +131,3 @@ jobs:
   ### if you need valgrind on mac, you can install it via
   # brew tap LouisBrunner/valgrind
   # brew install --HEAD LouisBrunner/valgrind/valgrind
-

.github/workflows/stubs.yml

@@ -0,0 +1,71 @@
+name: Check type stubs
+env:
+  version: 10.0.0
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - "master"
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  stubtest:
+    if: (github.event_name != 'pull_request') || (github.event.pull_request.draft == false)
+    runs-on: ubuntu-24.04
+    env:
+      PYTHON_VERSION: "3.14"
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install dependencies (SCIPOptSuite)
+        run: |
+          wget --quiet --no-check-certificate "https://github.com/scipopt/scip/releases/download/v${{ env.version }}/scipoptsuite_${{ env.version }}-1+jammy_amd64.deb"
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
+
+      - name: Setup python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install mypy
+        run: |
+          python -m pip install mypy
+
+      - name: Install PySCIPOpt
+        run: |
+          export CFLAGS="-O0 -ggdb -Wall -Wextra -Werror -Wno-error=deprecated-declarations" # Debug mode. More warnings. Warnings as errors, but allow deprecated declarations.
+          python -m pip install . -v 2>&1 | tee build.log
+
+      - name: Run MyPy
+        run: python -m mypy --package pyscipopt
+
+      - name: Run stubtest
+        run: stubs/test.sh
+
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      FILES: src/pyscipopt/scip.pyi
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "--version"
+
+      - name: Lint type stubs
+        run: ruff check ${{ env.FILES }} --extend-select ANN,I,PYI,RUF100
+
+      - name: Format type stubs
+        run: ruff format ${{ env.FILES }}

.github/workflows/test-release.yml

@@ -1,7 +1,7 @@
 name: TestPyPI release
 
 env:
-  version: 9.2.3
+  version: 10.0.0
 
 
 # runs only when a release is published, not on drafts
@@ -17,8 +17,8 @@ jobs:
 
       - name: Install dependencies (SCIPOptSuite)
         run: |
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
-          sudo apt-get update && sudo apt install -y ./SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
+          wget --quiet --no-check-certificate "https://github.com/scipopt/scip/releases/download/v${version}/scipoptsuite_${version}-1+jammy_amd64.deb"
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${version}-1+jammy_amd64.deb
 
       - name: Setup python 3
         uses: actions/setup-python@v4

.github/workflows/update-packages-and-documentation.yml

@@ -1,7 +1,7 @@
 name: Test and Release PyPI Package
 
 env:
-  version: 9.2.3
+  version: 10.0.0
 
 
 # runs only when a release is published, not on drafts
@@ -38,8 +38,8 @@ jobs:
 
       - name: Install dependencies (SCIPOptSuite)
         run: |
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
-          sudo apt-get update && sudo apt install -y ./SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
+          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
 
       - name: Setup python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -71,7 +71,9 @@ jobs:
 
       - name: Download dependencies (SCIPOptSuite)
         shell: powershell
-        run: wget https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-win64-VS15.exe -outfile scipopt-installer.exe
+        run: |
+          $url = "https://github.com/scipopt/scip/releases/download/v${{ env.version }}/scipoptsuite-${{ env.version }}-win-x64.exe"
+          Invoke-WebRequest -Uri $url -OutFile scipopt-installer.exe
 
       - name: Install dependencies (SCIPOptSuite)
         shell: cmd
@@ -107,8 +109,8 @@ jobs:
 
       - name: Install dependencies (SCIPOptSuite)
         run: |
-          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
-          sudo apt-get update && sudo apt install -y ./SCIPOptSuite-${{ env.version }}-Linux-ubuntu20.deb
+          wget --quiet --no-check-certificate https://github.com/scipopt/scip/releases/download/$(echo "v${{env.version}}" | tr -d '.')/scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
+          sudo apt-get update && sudo apt install -y ./scipoptsuite_${{ env.version }}-1+jammy_amd64.deb
 
       - name: Setup python 3
         uses: actions/setup-python@v4

CHANGELOG.md

@@ -2,18 +2,64 @@
 
 ## Unreleased
 ### Added
+- Added automated script for generating type stubs
+- Include parameter names in type stubs
+- Speed up MatrixExpr.sum(axis=...) via quicksum
+- Added structured_optimization_trace recipe for structured optimization progress tracking
+### Fixed
+- getBestSol() now returns None for infeasible problems instead of a Solution with NULL pointer
+- all fundamental callbacks now raise an error if not implemented
+- Fixed the type of MatrixExpr.sum(axis=...) result from MatrixVariable to MatrixExpr.
+- Updated IIS result in PyiisfinderExec()
+- Model.getVal now supports GenExpr type
+- Fixed lotsizing_lazy example
+- Fixed incorrect getVal() result when _bestSol.sol was outdated
+- Fixed segmentation fault when using Variable or Constraint objects after freeTransform() or Model destruction
+### Changed
+- changed default value of enablepricing flag to True
+- Speed up MatrixExpr.add.reduce via quicksum
+- Speed up np.ndarray(..., dtype=np.float64) @ MatrixExpr
+- Minimum numpy version increased from 1.16.0 to 1.19.0
+### Removed
+
+## 6.0.0 - 2025.xx.yy
+### Added
+- Support for SCIP 10.0.0
+- Added support for IIS - Irreducible Inconsistent Subsystems
+- Added 4 new events: TYPECHANGED, IMPLTYPECHANGED, DUALBOUNDIMPROVED, GAPUPDATED.
+- Support for new implied integrality
+- Wrapped varIsBinary(), varIsIntegral(), varIsImpliedIntegral(), varIsNonImpliedIntegral(), varGetImplType()
+- Interfaced some exact SCIP methods
+- wrapped SCIPprintStatisticsJson
+### Fixed
+### Changed
+### Removed
+- Removed methods chgAndConsCheckFlagWhenUpgr, chgAndConsRemovableFlagWhenUpgr
+
+## 5.7.0 - 2025.11.17
+### Added
 - Added possibility of having variables in exponent.
 - Added basic type stubs to help with IDE autocompletion and type checking.
 - MatrixVariable comparisons (<=, >=, ==) now support numpy's broadcast feature.
+- Added methods: getMaxDepth(), getPlungeDepth(), getLowerbound(), getCutoffbound(), getNNodeLPIterations(), getNStrongbranchLPIterations().
+- setup.py now automatically detects conda environments when SCIPOPTDIR is not defined.
+- Added function getStatus() to get variable status in variable class
+- Added function isActive() to get whether a variable is active in variable class
+- Added function markDoNotAggrVar() to prevent a variable from being aggregated
+- Added function markDoNotMultaggrVar() to prevent a variable from being multi-aggregated
 ### Fixed
 - Implemented all binary operations between MatrixExpr and GenExpr
 - Fixed the type of @ matrix operation result from MatrixVariable to MatrixExpr.
+- Fixed the case for returning None from the nodeselect callback in Node Selector plugins.
+- Fixed segmentation fault during Benders decomposition cleanup caused by double-free bug
 ### Changed
 - Add package extras for test dependencies in `pyproject.toml`
 - Speed up MatrixVariable.sum(axis=None) via quicksum
 - MatrixVariable now supports comparison with Expr
+- Benders subproblem memory is now automatically managed by the master Model - `freeBendersSubproblems()` is deprecated and no longer needed
 ### Removed
 
+
 ## 5.6.0 - 2025.08.26
 ### Added
 - More support for AND-Constraints

INSTALL.md

@@ -32,6 +32,8 @@ you need to specify the install location using the environment variable
     `set SCIPOPTDIR=<path_to_install_dir>` (**cmd**, **Cmder**, **WSL**)\
     `$Env:SCIPOPTDIR = "<path_to_install_dir>"` (**powershell**)
 
+**Note:** If `SCIPOPTDIR` is not set, the setup script will automatically attempt to detect a conda environment (via the `CONDA_PREFIX` environment variable) and use it if available. If no conda environment is detected, it will fall back to searching global installation paths.
+
 `SCIPOPTDIR` needs to have a subdirectory `lib` that contains the
 library, e.g. `libscip.so` (for Linux) and a subdirectory `include` that
 contains the corresponding header files:

LICENSE

@@ -1,21 +1,10 @@
 MIT License
 
-Copyright (c) 2023 Zuse Institute Berlin (ZIB)
+Copyright (c) 2025 Zuse Institute Berlin (ZIB)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person  btaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -119,3 +119,23 @@ Please cite [this paper](https://opus4.kobv.de/opus4-zib/frontdoor/index/index/d
 }
 ```
 as well as the corresponding [SCIP Optimization Suite report](https://scip.zib.de/index.php#cite) when you use this tool for a publication or other scientific work.
+
+Seeking Maintainers
+----------------------------------
+
+PySCIPOpt is sustained by volunteer effort, and as the project grows we are inviting more contributors and maintainers to join the team.
+
+What needs to be done
+----------------------
+These are the core responsibilities:
+
+* Community support: Going over the open issues regularly. Occasionally visiting Stack Overflow and OR.SE, as users also ask questions there.
+* PR review: Reviewing user pull requests, making sure that the CHANGELOG is updated, and all added methods are tested.
+* API coverage: keep expanding PySCIPOpt's coverage of SCIP's C API.
+* Documentation: help keep the documentation up to date, and add new tutorials/examples.
+* Releases: there should be a PySCIPOpt release with every SCIP release, at a minimum.
+
+Even if you are not interested in becoming a maintainer, but would like to help out occasionally, that would be very welcome as well!
+
+Send us an email over at **joao.goncalves.dionisio@gmail.com** if you're ready to take on the challenge :)
+