Skip to content

Commit

Permalink
add python mkl docs (#219)
Browse files Browse the repository at this point in the history
  • Loading branch information
bodono committed Mar 13, 2022
1 parent 195691e commit c785d2f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
16 changes: 11 additions & 5 deletions docs/src/api/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This module provides the :code:`SCS` class which is initialized using:
solver = scs.SCS(data,
cone,
use_indirect=False,
mkl=False,
gpu=False,
verbose=True,
normalize=True,
Expand All @@ -38,11 +39,16 @@ a dict that contains the :ref:`cones` information. The :code:`cone` dict
contains keys corresponding to the cone type and values corresponding to either
the cone length or the array that defines the cone (see the third column in
:ref:`cones` for the keys and what the corresponding values represent). The
:code:`b`, and :code:`c` must be 1d numpy arrays and :code:`P` and :code:`A`
must be scipy sparse matrices in CSC format; if they are not of the proper
format, SCS will attempt to convert them. The :code:`use_indirect` setting
switches between the sparse direct :ref:`linear_solver` (the default) or the
sparse indirect solver. The remaining fields are explained in :ref:`settings`.
:code:`b`, and :code:`c` entries must be 1d numpy arrays and the :code:`P` and
:code:`A` entries must be scipy sparse matrices in CSC format; if they are not
of the proper format, SCS will attempt to convert them. The
:code:`use_indirect` setting switches between the sparse direct
:ref:`linear_solver` (the default) or the sparse indirect solver. If the MKL
Pardiso direct solver for SCS is :ref:`installed <python_install>` then it can
be used by setting :code:`mkl=True`. If the GPU indirect solver for SCS is
:ref:`installed <python_install>` and a GPU is available then it can be used by
setting :code:`gpu=True`. The remaining fields are explained in
:ref:`settings`.

Then to solve the problem call:

Expand Down
10 changes: 8 additions & 2 deletions docs/src/install/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@ You can also install directly from source
cd scs-python
python setup.py install
You can install the gpu interface using
You can install the MKL Pardiso interface using

.. code:: bash
python setup.py install --scs --mkl
You can install the GPU interface using

.. code:: bash
Expand All @@ -42,7 +48,7 @@ You can install the gpu interface using
To test that SCS installed correctly, and you have pytest installed, run

.. code:: bash
pytest
See :ref:`here <python_interface>` for the API.

0 comments on commit c785d2f

Please sign in to comment.