Skip to content

Commit 0cf0304

Browse files
authored
Merge pull request #39 from jsiirola/solver-docs
Update formatting and links for solver table
2 parents 010cdec + 24f69fd commit 0cf0304

File tree

1 file changed

+42
-37
lines changed

1 file changed

+42
-37
lines changed
Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. -*- mode: rst -*-
2+
13
Using Solvers with Pyomo
24
========================
35

@@ -12,68 +14,71 @@ the license requirements for their desired solver.
1214

1315
<br />
1416

17+
..
18+
NOTE the use of Unicode nonbreaking spaces (xA0) and hyphens (x2011)
19+
in the PIP and CONDA command lines so that the commands render
20+
sensibly
21+
1522
.. list-table:: Available Solvers through ``pip`` and ``conda``
1623
:header-rows: 1
1724

1825
* - Solver
19-
- ``pip``
20-
- ``conda``
21-
- License
22-
- Documentation
26+
- Pip
27+
- Conda
28+
- License |br| Docs
2329
* - cplex
24-
- ``pip install cplex``
25-
- ``conda install -c ibmdecisionoptimization cplex``
30+
- ``pip install cplex``
31+
- ``conda install ‑c ibmdecisionoptimization \    cplex``
2632
- `License <https://www.ibm.com/products/ilog-cplex-optimization-studio/pricing>`__
27-
- `Documentation <https://www.ibm.com/docs/en/icos/22.1.1?topic=cplex-installing>`__
33+
`Docs <https://www.ibm.com/docs/en/icos/latest?topic=cplex-installing>`__
34+
* - CPoptimizer
35+
- ``pip install cplex \    docplex``
36+
- ``conda install ‑c ibmdecisionoptimization \    cplex docplex``
37+
- `License <https://github.com/IBMDecisionOptimization/docplex-doc/blob/master/LICENSE.txt>`__
38+
`Docs <https://ibmdecisionoptimization.github.io/docplex-doc/getting_started_python.html>`__
2839
* - cyipopt
29-
- ``pip install cyipopt``
30-
- ``conda install -c conda-forge cyipopt``
40+
- ``pip install cyipopt``
41+
- ``conda install ‑c condaforge cyipopt``
3142
- `License <https://cyipopt.readthedocs.io/en/stable/#copyright>`__
32-
- `Documentation <https://cyipopt.readthedocs.io/en/stable/install.html>`__
33-
* - DOcplex
34-
- ``pip install docplex``
35-
- ``conda install -c ibmdecisionoptimization docplex``
36-
- `License <https://github.com/IBMDecisionOptimization/docplex-doc/blob/master/LICENSE.txt>`__
37-
- `Documentation <https://ibmdecisionoptimization.github.io/docplex-doc/getting_started_python.html>`__
43+
`Docs <https://cyipopt.readthedocs.io/en/stable/install.html>`__
3844
* - glpk
3945
- N/A
40-
- ``conda install -c conda-forge glpk``
46+
- ``conda install ‑c condaforge glpk``
4147
- `License <https://www.gnu.org/licenses/licenses.html>`__
42-
- `Documentation <https://www.gnu.org/software/glpk/>`__
48+
`Docs <https://www.gnu.org/software/glpk/>`__
4349
* - Gurobi
44-
- ``pip install gurobipy``
45-
- ``conda install -c gurobi gurobi``
50+
- ``pip install gurobipy``
51+
- ``conda install ‑c gurobi gurobi``
4652
- `License <https://www.gurobi.com/solutions/licensing/>`__
47-
- `Documentation <https://support.gurobi.com/hc/en-us/articles/360044290292-How-do-I-install-Gurobi-for-Python>`__
53+
`Docs <https://support.gurobi.com/hc/en-us/articles/360044290292-How-do-I-install-Gurobi-for-Python>`__
4854
* - HiGHS
49-
- ``pip install highspy``
50-
- ``conda install -c conda-forge highspy``
51-
- `License <https://ergo-code.github.io/HiGHS/stable/>`__
52-
- `Documentation <https://ergo-code.github.io/HiGHS/dev/interfaces/python/>`__
55+
- ``pip install highspy``
56+
- ``conda install ‑c condaforge highspy``
57+
- `License <https://github.com/ERGO-Code/HiGHS/blob/master/LICENSE.txt>`__
58+
`Docs <https://ergo-code.github.io/HiGHS/dev/interfaces/python/>`__
5359
* - MAiNGO
54-
- ``pip install maingopy``
60+
- ``pip install maingopy``
5561
- N/A
56-
- `License <https://git.rwth-aachen.de/avt-svt/public/maingo/-/blob/master/LICENSE?ref_type=heads>`__
57-
- `Documentation <https://avt-svt.pages.rwth-aachen.de/public/maingo/install.html#get_maingo>`__
62+
- `License <https://git.rwth-aachen.de/avt-svt/public/maingo/-/blob/master/LICENSE>`__
63+
`Docs <https://avt-svt.pages.rwth-aachen.de/public/maingo/install.html>`__
5864
* - PyMUMPS
59-
- ``pip install pymumps``
60-
- ``conda install -c conda-forge pymumps``
65+
- ``pip install pymumps``
66+
- ``conda install ‑c condaforge pymumps``
6167
- `License <https://github.com/PyMumps/pymumps/blob/master/COPYING>`__
62-
- `Documentation <https://github.com/pymumps/pymumps>`__
68+
`Docs <https://github.com/pymumps/pymumps>`__
6369
* - SCIP
6470
- N/A
65-
- ``conda install -c conda-forge scip``
71+
- ``conda install ‑c condaforge scip``
6672
- `License <https://www.scipopt.org/scip/doc/html/LICENSE.php>`__
67-
- `Documentation <https://www.scipopt.org/index.php#download>`__
73+
`Docs <https://www.scipopt.org/index.php#download>`__
6874
* - XPRESS
69-
- ``pip install xpress``
70-
- ``conda install -c fico-xpress xpress``
75+
- ``pip install xpress``
76+
- ``conda install ‑c ficoxpress xpress``
7177
- `License <https://www.fico.com/en/fico-xpress-trial-and-licensing-options>`__
72-
- `Documentation <https://www.fico.com/fico-xpress-optimization/docs/dms2019-02/solver/optimizer/python/HTML/chIntro_sec_secInstall.html>`__
73-
78+
`Docs <https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/python/HTML/chIntro.html?scroll=secInstall>`__
7479

7580
.. note::
7681

7782
We compiled this table of solvers to help you get started, but we encourage
7883
you to consult the official documentation of your desired solver for the most
79-
up-to-date and detailed information.
84+
up-to-date and detailed information.

0 commit comments

Comments
 (0)