update stale python install docs (#292)

cvxgrp · Oct 4, 2024 · 3538473 · 3538473
1 parent bdc5866
commit 3538473
Showing 1 changed file with 18 additions and 21 deletions.
diff --git a/docs/src/install/python.rst b/docs/src/install/python.rst
@@ -9,46 +9,43 @@ The easiest way to install the python version is using `pip <https://pypi.org/pr
 
   pip install scs
 
-SCS depends on python packages numpy and scipy to run and on numpy to install.
-It uses numpy to tell it what :ref:`BLAS and LAPACK <blas_lapack>` libraries
-to link against. If you run into an error like this:
+You can also install directly from source
 
 .. code:: bash
 
-  RuntimeError: Found /usr/lib/libcblas.dylib, but that file is a symbolic link to
-  the MacOS Accelerate framework, which is not supported by NumPy
+  git clone --recursive https://github.com/bodono/scs-python.git
+  cd scs-python
+  python -m pip install --verbose .
 
-you can try:
+If you have MKL, you can install the MKL Pardiso interface using
 
 .. code:: bash
 
-  brew install openblas
-  OPENBLAS="$(brew --prefix openblas)" pip install scs
+  python -m pip install --verbose -Csetup-args=-Dlink_mkl=true .
 
-You can also install directly from source
+See :ref:`here <python_interface>` for how to enable MKL when solving. MKL is typically
+faster than the built-in linear system solver.
 
-.. code:: bash
+To test that SCS installed correctly, and you have pytest installed, run
 
-  git clone --recursive https://github.com/bodono/scs-python.git
-  cd scs-python
-  python setup.py install
+.. code:: bash
 
-You can install the MKL Pardiso interface using
+  python -m pytest .
 
-.. code:: bash
+See :ref:`here <python_interface>` for the full SCS python API.
 
-  python setup.py install --scs --mkl
+Legacy options
+--------------
 
-You can install the GPU interface using
+You can install with OpenMP parallelization support using
 
 .. code:: bash
 
-  python setup.py install --scs --gpu
+  python legacy_setup.py install --scs --openmp
 
-To test that SCS installed correctly, and you have pytest installed, run
+You can install the GPU interface using (the GPU solver is no longer recommended)
 
 .. code:: bash
 
-  pytest
+  python legacy_setup.py install --scs --gpu
 
-See :ref:`here <python_interface>` for the API.