source: ThirdParty/HSL/stable/1.1/INSTALL.HSL @ 1345

Installation of certain Harwell subroutines for IPOPT.

*********************************************************************
Note: It is YOUR RESPONSIBILITY to ensure that you are entitled to
      download and use this third party package.
*********************************************************************

Information on the Harwell Subroutine Library (HSL) is available at

http://www.cse.clrc.ac.uk/nag/hsl/

Some of the required HSL routines are available in the HSL Archive.
The subroutines in the HSL Archive are free for non-commercial
purposes (make sure you read the license).

The sparse symmetric linear solvers that you can use in Ipopt are MA57
(if you have access for a commercial copy of the HSL library or are an
academic who wants to use the "HSL 2007 for Researchers" library)
and/or MA27 (if you have only access to the HSL Archive).  In
addition, you should get MC19 (from the ASL archive).

Different ways to use the HSL routines in Ipopt:
------------------------------------------------

1. If you download the HSL sources when you configure and compile
   Ipopt, those files will be compiled and included into the Ipopt
   library and executable.

2. You can also compile Ipopt without the HSL source files.  In this
   case, Ipopt will be built without the HSL routines, but it will be
   possible to load a shared library at runtime that contains the HSL
   routines.  For this, you need to provide this shared library.  You
   can use the Makefiles in this ThirdParty/HSL directory to generate
   this shared library.  For details, please look at the

   "Compiling a shared library with HSL" 

   below in this file.

Instructions on how to download files from the HSL Archive or HSL 2007:
-----------------------------------------------------------------------

If you need to download subroutines from the HSL Archive or from the
HSL2007 for Researchers website, this is how it goes:

In order to download the HSL Archive subroutines (like ma27 and mc19),
you need to register at the HSL Archive website

http://hsl.rl.ac.uk/archive/hslarchive.html

or the HSL 2007 for Researchers website:

http://hsl.rl.ac.uk/hsl2007/hsl20074researchers.html

After that you can log in and go to the page that lists all the
available HSL packages for download.  If you then click on the name of
the desired routine (like MA27), you get to a download page, where one
of the button reads "Download Package (comments removed)".

Click on that button (leave the precision choice at default "Double
Precision").  This brings up a webpage which contains the code for the
subroutine as text.  All you have to do now is to save this page (all
of it, even if there are more than one subroutines in it) into the a
file called "ma27ad.f".  (If "Save page to..." doesn't work, you can
copy the content of this page into an editor and save it there.)

Similarly, if you want to get the MC19 routine, do the same steps as above
and safe the context in a file called "mc19ad.f" .

For neither MA27 or MC19 it is necessary to download any dependencies.

If you want to use MA57, please make sure that all source code for
MA57 ***including dependencies*** is in a file called ma57ad.f.
Currently, the dependencies are the files:

 fd15ad.f
 mc21ad.f
 mc34ad.f
 mc47ad.f
 mc59ad.f
 mc64ad.f
 mc71ad.f

plus possibly a dummy file (metis.f) for METIS.  However, it is
strongly suggested that you use METIS (look at the ThirdParty/Metis
directory for instructions, or use the --with-metis configure flag to
specify a procompiled Metis library).


Instructions on where to put the source code:
---------------------------------------------

Copy the source files for the required HSL routines into this
directory before running the `configure' script.  The configuration
script will detect which source files you have and prepare the
Makefile accordingly.


Compiling a shared library with HSL
===================================

Note: This has not yet been successfully tested on all platforms.  It
      should work on most UNIX systems (including Linux), and also on
      Cygwin and MSys.  So far, it does not seem to work on AIX.

If you already built an Ipopt executable or library, you can still add
the functionality of the HSL routines without recompiling Ipopt.  The
following describes the mechanism that Ipopt uses to use a Harwell
Subroutine:

1. If the Ipopt binary/library had been compiled with HSL files
   present, those subroutines are always available.

2. If you are selecting a Harwell subroutine (such as MA27 or MA57 as
   argument to the "linear_solver" option) which has not been available
   when Ipopt had been compiled, Ipopt will attempt to load a shared
   library containing this routine.  The name of the shared library
   depends on the operating system:

   - Windows (Cygwin/MSys/MSVC): libhsl.dll
   - Darwin: libhsl.dylib
   - UNIX (including Linux): libhsl.so

   If this library is not found, or the selected routine is not
   available in this shared library, Ipopt will abort with an error
   message.

An easy way to generate this shared library is to use the "configure"
script in this directory, using the following instructions:

1. Put the HSL routines that are available to you into this directory
   (see above for the proper names, and how to get them).

2. Run the configure script of ThirdParty/HSL (not the one in the
   Ipopt base directory!).  As arguments, you would essentially
   provide the same flags as you would usually when you compile Ipopt,
   but you need to add the flag "--enable-loadable-library".  Since
   you are compiling a shared library, you cannot specify the
   "--disable-shared" flag.

3. Then just run "make install".  If it works, this should give you
   the shared library in the "lib" subdirectory in the directory where
   you run the ThirdParty/HSL/configure script.

4. To use the shared library, you need to make sure that Ipopt will
   find it when it is looking for it.  On most UNIX systems, you need
   to put the shared library into a directory in the LD_LIBRARY_PATH
   search path, and on Windows it needs to be in the PATH.