Merge pull request Pyomo#3165 from MAiNGO-github/maingo_interface

Added MAiNGO appsi-interface
IDAES · May 8, 2024 · 34b15d8 · 34b15d8
2 parents f8459a7 + fbd9a0a
commit 34b15d8
Show file tree

Hide file tree

Showing 10 changed files with 1,024 additions and 107 deletions.
diff --git a/.github/workflows/test_branches.yml b/.github/workflows/test_branches.yml
@@ -268,6 +268,8 @@ jobs:
                 || echo "WARNING: Gurobi is not available"
             python -m pip install --cache-dir cache/pip xpress \
                 || echo "WARNING: Xpress Community Edition is not available"
+            python -m pip install --cache-dir cache/pip maingopy \
+                || echo "WARNING: MAiNGO is not available"
             if [[ ${{matrix.python}} == pypy* ]]; then
                 echo "skipping wntr for pypy"
             else

diff --git a/.github/workflows/test_pr_and_main.yml b/.github/workflows/test_pr_and_main.yml
@@ -305,6 +305,8 @@ jobs:
                 || echo "WARNING: Gurobi is not available"
             python -m pip install --cache-dir cache/pip xpress \
                 || echo "WARNING: Xpress Community Edition is not available"
+            python -m pip install --cache-dir cache/pip maingopy \
+                || echo "WARNING: MAiNGO is not available"
             if [[ ${{matrix.python}} == pypy* ]]; then
                 echo "skipping wntr for pypy"
             else

diff --git a/doc/OnlineDocs/library_reference/appsi/appsi.solvers.maingo.rst b/doc/OnlineDocs/library_reference/appsi/appsi.solvers.maingo.rst
@@ -0,0 +1,14 @@
+MAiNGO
+======
+
+.. autoclass:: pyomo.contrib.appsi.solvers.maingo.MAiNGOConfig
+  :members:
+  :inherited-members:
+  :undoc-members:
+  :show-inheritance:
+
+.. autoclass:: pyomo.contrib.appsi.solvers.maingo.MAiNGO
+  :members:
+  :inherited-members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/doc/OnlineDocs/library_reference/appsi/appsi.solvers.rst b/doc/OnlineDocs/library_reference/appsi/appsi.solvers.rst
@@ -13,3 +13,4 @@ Solvers
    appsi.solvers.cplex
    appsi.solvers.cbc
    appsi.solvers.highs
+   appsi.solvers.maingo
diff --git a/pyomo/contrib/appsi/base.py b/pyomo/contrib/appsi/base.py
@@ -1661,15 +1661,15 @@ def license_is_valid(self) -> bool:
 
     @property
     def options(self):
-        for solver_name in ['gurobi', 'ipopt', 'cplex', 'cbc', 'highs']:
+        for solver_name in ['gurobi', 'ipopt', 'cplex', 'cbc', 'highs', 'maingo']:
             if hasattr(self, solver_name + '_options'):
                 return getattr(self, solver_name + '_options')
         raise NotImplementedError('Could not find the correct options')
 
     @options.setter
     def options(self, val):
         found = False
-        for solver_name in ['gurobi', 'ipopt', 'cplex', 'cbc', 'highs']:
+        for solver_name in ['gurobi', 'ipopt', 'cplex', 'cbc', 'highs', 'maingo']:
             if hasattr(self, solver_name + '_options'):
                 setattr(self, solver_name + '_options', val)
                 found = True

diff --git a/pyomo/contrib/appsi/plugins.py b/pyomo/contrib/appsi/plugins.py
@@ -11,7 +11,7 @@
 
 from pyomo.common.extensions import ExtensionBuilderFactory
 from .base import SolverFactory
-from .solvers import Gurobi, Ipopt, Cbc, Cplex, Highs
+from .solvers import Gurobi, Ipopt, Cbc, Cplex, Highs, MAiNGO
 from .build import AppsiBuilder
 
 
@@ -30,3 +30,6 @@ def load():
     SolverFactory.register(name='highs', doc='Automated persistent interface to Highs')(
         Highs
     )
+    SolverFactory.register(
+        name='maingo', doc='Automated persistent interface to MAiNGO'
+    )(MAiNGO)
diff --git a/pyomo/contrib/appsi/solvers/__init__.py b/pyomo/contrib/appsi/solvers/__init__.py
@@ -15,3 +15,4 @@
 from .cplex import Cplex
 from .highs import Highs
 from .wntr import Wntr, WntrResults
+from .maingo import MAiNGO