From ce6335222121335f76b306f4ae8b66c753d5bfdb Mon Sep 17 00:00:00 2001 From: Brendan O'Donoghue Date: Fri, 4 Oct 2024 12:15:33 +0100 Subject: [PATCH] update stale python install docs --- docs/src/install/python.rst | 39 +++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/docs/src/install/python.rst b/docs/src/install/python.rst index 1b9a9d37..680fe677 100644 --- 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 ` 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 ` 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 ` 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 ` for the API.