Skip to content

Commit

Permalink
Update documentation (which is still slim but is a reasonable start)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmundt committed Feb 14, 2024
1 parent 571cc08 commit b19c75a
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions doc/OnlineDocs/developer_reference/solvers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,19 @@ Pyomo offers interfaces into multiple solvers, both commercial and open source.
Interface Implementation
------------------------

TBD: How to add a new interface; the pieces.
All new interfaces should be built upon one of two classes (currently):
``pyomo.contrib.solver.base.SolverBase`` or ``pyomo.contrib.solver.base.PersistentSolverBase``.

All solvers should have the following:

.. autoclass:: pyomo.contrib.solver.base.SolverBase
:members:

Persistent solvers should also include:

.. autoclass:: pyomo.contrib.solver.base.PersistentSolverBase
:show-inheritance:
:members:

Results
-------
Expand Down Expand Up @@ -56,4 +67,10 @@ returned solver messages or logs for more information.
Solution
--------

TBD: How to load/parse a solution.
Solutions can be loaded back into a model using a ``SolutionLoader``. A specific
loader should be written for each unique case. Several have already been
implemented. For example, for ``ipopt``:

.. autoclass:: pyomo.contrib.solver.solution.SolSolutionLoader
:show-inheritance:
:members:

0 comments on commit b19c75a

Please sign in to comment.