Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arght committed Dec 21, 2023
1 parent 619dfa0 commit a7e1831
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,27 +122,32 @@ GitHub Repository (the hard way)
4. Install openTEPES via pip by ``pip install .``

Solvers
###########
#######

GLPK
================================
=====
As an easy option for installation, we have the free and open-source `GLPK solver <https://www.gnu.org/software/glpk/>`_. However, it takes too much time for large-scale problems. It can be installed using: ``conda install -c conda-forge glpk``.

CBC
================================
=====
The `CBC solver <https://github.com/coin-or/Cbc>`_ is our recommendation if you want a free and open-source solver. For Windows users, the effective way to install the CBC solver is downloading the binaries from `this link <https://www.coin-or.org/download/binary/Cbc/Cbc-2.10.5-x86_64-w64-mingw32.zip>`_, copy and paste the *cbc.exe* file to the PATH that is the "bin" directory of the Anaconda or Miniconda environment. It can be installed using: ``conda install -c conda-forge coincbc``.

Gurobi
================================
======
Another recommendation is the use of `Gurobi solver <https://www.gurobi.com/>`_. However, it is commercial solver but most powerful than GLPK and CBC for large-scale problems.
As a commercial solver it needs a license that is free of charge for academic usage by signing up in `Gurobi webpage <https://pages.gurobi.com/registration/>`_.
It can be installed using: ``conda install -c gurobi gurobi`` and then ask for an academic or commercial license. Activate the license in your computer using the ``grbgetkey`` command (you need to be in the university domain if you are installing an academic license).

Mosek
================================
=====
Another alternative is the `Mosek solver <https://www.mosek.com/>`_. Note that it is a commercial solver and you need a license for it. Mosek is a good alternative to deal with QPs, SOCPs, and SDPs problems. You only need to use ``conda install -c mosek mosek`` for installation and request a license (academic or commercial).
To request the academic one, you can request `here <https://www.mosek.com/products/academic-licenses/>`_. Moreover, Mosek brings a `license guide <https://docs.mosek.com/9.2/licensing/index.html>`_. But if you are request an academic license, you will receive the license by email, and you only need to locate it in the following path ``C:\Users\(your user)\mosek`` in your computer.

GAMS
=====
The model openTEPES can also be solved with GAMS and a valid GAMS license for a solver. The GAMS interface is not included in the openTEPES package and must be installed separately.
This option is activated by calling the model with the solver name 'gams'.

Get started
###########

Expand Down
3 changes: 3 additions & 0 deletions doc/rst/Download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Gurobi, HiGHS, or SCIP solvers can be installed as a package::
pip install highspy
conda install -c conda-forge pyscipopt

The model openTEPES can also be solved with GAMS and a valid GAMS license for a solver. The GAMS interface is not included in the openTEPES package and must be installed separately.
This option is activated by calling the model with the solver name 'gams'.

Besides, it also requires the following packages:

- `Pandas <https://pandas.pydata.org/>`_ for inputting data and outputting results
Expand Down

0 comments on commit a7e1831

Please sign in to comment.