Skip to content

Commit

Permalink
Tidy the windows HSL install instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
moorepants committed Sep 8, 2024
1 parent 50555f2 commit 16298cb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Version History
[1.5.0.dev0] - XXXX-XX-XX
~~~~~~~~~~~~~~~~~~~~~~~~~

Added
+++++

- Added instructions for using the HSL solvers on Windows.

Changed
+++++++

Expand Down
30 changes: 16 additions & 14 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ Conda Forge binaries with HSL
-----------------------------

On Linux
-----------------------------
~~~~~~~~

It is possible to use the HSL linear solvers with cyipopt installed via Conda
Forge. To do so, first download the HSL source code tarball. The following
Expand Down Expand Up @@ -420,25 +420,28 @@ you may need ``problem.add_option('hsllib', 'libcoinhsl.dylib')``.


On Windows
-----------------------------
On windows it could be possible to use HSL solvers with Conda version of cyipopt,
first install cyipopt via standard call::
~~~~~~~~~~

On windows it could be possible to use HSL solvers with Conda version of
cyipopt, first install cyipopt via standard call::

$ conda create -n hsl-test -c conda-forge cyipopt
$ conda activate hsl-test

Download HSL linear solvers, e.g. ``ma27, ma57, ma86`` from its
official website <http://www.hsl.rl.ac.uk/ipopt/>. Download the ``windows`` binaries option,
in this example, we are using "CoinHSL Archive 2023.11.17 (windows binaries)" option.
This will download a zipped file that contains a folder ``bin``. Copy all the DLL files from
that folder into your conda env\Library\bin folder
(This folder should also contain the an ipopt dll file installed with cyipopt (in our case it was called ``ipopt-3.dll``)::
Download HSL linear solvers, e.g. ``ma27, ma57, ma86`` from its official
website <http://www.hsl.rl.ac.uk/ipopt/>. Download the ``windows`` binaries
option, in this example, we are using "CoinHSL Archive 2023.11.17 (windows
binaries)" option. This will download a zipped file that contains a folder
``bin``. Copy all the DLL files from that folder into your conda
``env\Library\bin`` folder (This folder should also contain the an ipopt dll
file installed with cyipopt (in our case it was called ``ipopt-3.dll``)::

<conda_location>\envs\<env_name>\Library\bin

Once the DLL files are placed you should be able to access the HSL solvers using solver options::
Once the DLL files are placed you should be able to access the HSL solvers
using solver options::

problem.add_option('linear_solver', 'ma57')
problem.add_option('linear_solver', 'ma57')

If all works well, you should see the following when setting ``tee=True``::

Expand All @@ -450,5 +453,4 @@ If all works well, you should see the following when setting ``tee=True``::

This is Ipopt version 3.14.16, running with linear solver ma27.

This was tested on Windows 11 x64 with Ipopt version 3.14.16.

This was tested on Windows 11 x64 with Ipopt version 3.14.16.

0 comments on commit 16298cb

Please sign in to comment.