Interface to GiNaC for Simplification

.github/workflows/test_branches.yml

@@ -94,6 +94,14 @@ jobs:
           PYENV: conda
           PACKAGES: mpi4py
 
+        - os: ubuntu-latest
+          python: 3.11
+          other: /singletest
+          category: "-m 'neos or importtest'"
+          skip_doctest: 1
+          TARGET: linux
+          PYENV: pip
+
         - os: ubuntu-latest
           python: '3.10'
           other: /cython
@@ -149,6 +157,24 @@ jobs:
     #    path: cache/os
     #    key: pkg-${{env.CACHE_VER}}.0-${{runner.os}}
 
+    - name: install GiNaC
+      if: matrix.other == '/singletest'
+      run: |
+        cd ..
+        curl https://www.ginac.de/CLN/cln-1.3.7.tar.bz2 >cln-1.3.7.tar.bz2
+        tar -xvf cln-1.3.7.tar.bz2
+        cd cln-1.3.7
+        ./configure
+        make -j 2
+        sudo make install
+        cd ..
+        curl https://www.ginac.de/ginac-1.8.7.tar.bz2 >ginac-1.8.7.tar.bz2
+        tar -xvf ginac-1.8.7.tar.bz2
+        cd ginac-1.8.7
+        ./configure
+        make -j 2
+        sudo make install
+
     - name: TPL package download cache
       uses: actions/cache@v4
       if: ${{ ! matrix.slim }}
@@ -608,13 +634,26 @@ jobs:
         echo ""
         pyomo build-extensions --parallel 2
 
+    - name: Install GiNaC Interface
+      if: matrix.other == '/singletest'
+      run: |
+        export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+        echo "LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
+        cd pyomo/contrib/simplification/
+        $PYTHON_EXE build.py --inplace
+
     - name: Report pyomo plugin information
       run: |
         echo "$PATH"
         pyomo help --solvers || exit 1
         pyomo help --transformations || exit 1
         pyomo help --writers || exit 1
 
+    - name: Run Simplification Tests
+      if: matrix.other == '/singletest'
+      run: |
+        pytest -v -m 'simplification' pyomo/contrib/simplification/tests/test_simplification.py --junitxml="TEST-pyomo-simplify.xml"
+
     - name: Run Pyomo tests
       if: matrix.mpi == 0
       run: |

.github/workflows/test_pr_and_main.yml

@@ -179,6 +179,24 @@ jobs:
     #    path: cache/os
     #    key: pkg-${{env.CACHE_VER}}.0-${{runner.os}}
 
+    - name: install GiNaC
+      if: matrix.other == '/singletest'
+      run: |
+        cd ..
+        curl https://www.ginac.de/CLN/cln-1.3.7.tar.bz2 >cln-1.3.7.tar.bz2
+        tar -xvf cln-1.3.7.tar.bz2
+        cd cln-1.3.7
+        ./configure
+        make -j 2
+        sudo make install
+        cd ..
+        curl https://www.ginac.de/ginac-1.8.7.tar.bz2 >ginac-1.8.7.tar.bz2
+        tar -xvf ginac-1.8.7.tar.bz2
+        cd ginac-1.8.7
+        ./configure
+        make -j 2
+        sudo make install
+
     - name: TPL package download cache
       uses: actions/cache@v4
       if: ${{ ! matrix.slim }}
@@ -638,13 +656,26 @@ jobs:
         echo ""
         pyomo build-extensions --parallel 2
 
+    - name: Install GiNaC Interface
+      if: matrix.other == '/singletest'
+      run: |
+        export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+        echo "LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
+        cd pyomo/contrib/simplification/
+        $PYTHON_EXE build.py --inplace
+
     - name: Report pyomo plugin information
       run: |
         echo "$PATH"
         pyomo help --solvers || exit 1
         pyomo help --transformations || exit 1
         pyomo help --writers || exit 1
 
+    - name: Run Simplification Tests
+      if: matrix.other == '/singletest'
+      run: |
+        pytest -v -m 'simplification' pyomo/contrib/simplification/tests/test_simplification.py --junitxml="TEST-pyomo-simplify.xml"
+
     - name: Run Pyomo tests
       if: matrix.mpi == 0
       run: |

pyomo/contrib/simplification/__init__.py

@@ -0,0 +1,12 @@
+#  ___________________________________________________________________________
+#
+#  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.
+#  ___________________________________________________________________________
+
+from .simplify import Simplifier

pyomo/contrib/simplification/build.py

@@ -0,0 +1,108 @@
+#  ___________________________________________________________________________
+#
+#  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 glob
+import os
+import shutil
+import sys
+import tempfile
+from distutils.dist import Distribution
+
+from pybind11.setup_helpers import Pybind11Extension, build_ext
+from pyomo.common.envvar import PYOMO_CONFIG_DIR
+from pyomo.common.fileutils import find_library, this_file_dir
+
+
+def build_ginac_interface(args=None):
+    if args is None:
+        args = list()
+    dname = this_file_dir()
+    _sources = ['ginac_interface.cpp']
+    sources = list()
+    for fname in _sources:
+        sources.append(os.path.join(dname, fname))
+
+    ginac_lib = find_library('ginac')
+    if ginac_lib is None:
+        raise RuntimeError(
+            'could not find GiNaC library; please make sure it is in the LD_LIBRARY_PATH environment variable'
+        )
+    ginac_lib_dir = os.path.dirname(ginac_lib)
+    ginac_build_dir = os.path.dirname(ginac_lib_dir)
+    ginac_include_dir = os.path.join(ginac_build_dir, 'include')
+    if not os.path.exists(os.path.join(ginac_include_dir, 'ginac', 'ginac.h')):
+        raise RuntimeError('could not find GiNaC include directory')
+
+    cln_lib = find_library('cln')
+    if cln_lib is None:
+        raise RuntimeError(
+            'could not find CLN library; please make sure it is in the LD_LIBRARY_PATH environment variable'
+        )
+    cln_lib_dir = os.path.dirname(cln_lib)
+    cln_build_dir = os.path.dirname(cln_lib_dir)
+    cln_include_dir = os.path.join(cln_build_dir, 'include')
+    if not os.path.exists(os.path.join(cln_include_dir, 'cln', 'cln.h')):
+        raise RuntimeError('could not find CLN include directory')
+
+    extra_args = ['-std=c++11']
+    ext = Pybind11Extension(
+        'ginac_interface',
+        sources=sources,
+        language='c++',
+        include_dirs=[cln_include_dir, ginac_include_dir],
+        library_dirs=[cln_lib_dir, ginac_lib_dir],
+        libraries=['cln', 'ginac'],
+        extra_compile_args=extra_args,
+    )
+
+    class ginacBuildExt(build_ext):
+        def run(self):
+            basedir = os.path.abspath(os.path.curdir)
+            if self.inplace:
+                tmpdir = this_file_dir()
+            else:
+                tmpdir = os.path.abspath(tempfile.mkdtemp())
+            print("Building in '%s'" % tmpdir)
+            os.chdir(tmpdir)
+            try:
+                super(ginacBuildExt, self).run()
+                if not self.inplace:
+                    library = glob.glob("build/*/ginac_interface.*")[0]
+                    target = os.path.join(
+                        PYOMO_CONFIG_DIR,
+                        'lib',
+                        'python%s.%s' % sys.version_info[:2],
+                        'site-packages',
+                        '.',
+                    )
+                    if not os.path.exists(target):
+                        os.makedirs(target)
+                    shutil.copy(library, target)
+            finally:
+                os.chdir(basedir)
+                if not self.inplace:
+                    shutil.rmtree(tmpdir, onerror=handleReadonly)
+
+    package_config = {
+        'name': 'ginac_interface',
+        'packages': [],
+        'ext_modules': [ext],
+        'cmdclass': {"build_ext": ginacBuildExt},
+    }
+
+    dist = Distribution(package_config)
+    dist.script_args = ['build_ext'] + args
+    dist.parse_command_line()
+    dist.run_command('build_ext')
+
+
+if __name__ == '__main__':
+    build_ginac_interface(sys.argv[1:])