Changeset 2462


Ignore:
Timestamp:
Oct 3, 2011 6:26:58 AM (9 years ago)
Author:
stefan
Message:

update installation instructions

File:
1 edited

Legend:

Unmodified
Added
Removed
  • ThirdParty/HSL/trunk/INSTALL.HSL

    r2458 r2462  
    1 Installation of certain Harwell subroutines for IPOPT.
     1Installation of certain Harwell subroutines.
    22
    33*********************************************************************
     
    1010http://www.hsl.rl.ac.uk/
    1111
    12 Some of the required HSL routines are available in the HSL Archive.
    13 The subroutines in the HSL Archive are free for non-commercial
    14 purposes (make sure you read the license).
     12For use by COIN-OR, STFC provides special packages at
    1513
    16 The sparse symmetric linear solvers that you can use in Ipopt are MA57
    17 (if you have access for a commercial copy of the HSL library or are an
    18 academic who wants to use the "HSL 2007 for Researchers" library)
    19 and/or MA27 (if you have only access to the HSL Archive).  In
    20 addition, you should get MC19 (from the ASL archive).
     14http://www.hsl.rl.ac.uk/ipopt/
    2115
    22 Different ways to use the HSL routines in Ipopt:
    23 ------------------------------------------------
     16which can be build independently or within the buildsystem in this
     17directory.
     18
     19Different ways to use the HSL routines in COIN-OR Ipopt:
     20--------------------------------------------------------
    2421
    25221. If you download the HSL sources when you configure and compile
    2623   Ipopt, those files will be compiled and included into the Ipopt
    27    library and executable.
     24   executable.
    2825
    29262. You can also compile Ipopt without the HSL source files.  In this
     
    3128   possible to load a shared library at runtime that contains the HSL
    3229   routines.  For this, you need to provide this shared library.  You
    33    can use the Makefiles in this ThirdParty/HSL directory to generate
     30   can use the Makefile of the coinhsl package obtained from HSL or
     31   the Makefiles in this ThirdParty/HSL directory to generate
    3432   this shared library.  For details, please look at the
    3533
     
    3836   below in this file.
    3937
    40 Instructions on how to download files from the HSL Archive or HSL 2007:
    41 -----------------------------------------------------------------------
     38Instructions on providing the source code for ThirdParty/HSL:
     39-------------------------------------------------------------
    4240
    43 If you need to download subroutines from the HSL Archive or from the
    44 HSL2007 for Researchers website, this is how it goes:
     41First, follow the links at http://www.hsl.rl.ac.uk/ipopt to register and
     42obtain an archive coinhsl-x.y.z.tar.gz.
    4543
    46 In order to download the HSL Archive subroutines (like ma27 and mc19),
    47 you need to register at the HSL Archive website
     44Unpack this archive via
     45  gunzip coinhsl-x.y.z.tar.gz
     46  tar xf coinhsl-x.y.z.tar
    4847
    49 http://hsl.rl.ac.uk/archive/hslarchive.html
     48Then copy the directories for all HSL codes that you want to use
     49(e.g., mc19, ma27, ma28, hsl_ma77) and the directory named "common"
     50to this directory before running the `configure' script.
     51The configuration script will detect which source files you have
     52and prepare the Makefile accordingly.
    5053
    51 or the HSL 2007 for Researchers website:
    52 
    53 http://hsl.rl.ac.uk/hsl2007/hsl20074researchers.html
    54 
    55 After that you can log in and go to the page that lists all the
    56 available HSL packages for download.  If you then click on the name of
    57 the desired routine (like MA27), you get to a download page, where one
    58 of the button reads "Download Package (comments removed)".
    59 
    60 Click on that button (leave the precision choice at default "Double
    61 Precision").  This brings up a webpage which contains the code for the
    62 subroutine as text.  All you have to do now is to save this page (all
    63 of it, even if there are more than one subroutines in it) into the a
    64 file called "ma27ad.f".  (If "Save page to..." doesn't work, you can
    65 copy the content of this page into an editor and save it there.)
    66 
    67 Similarly, if you want to get the MC19 routine, do the same steps as above
    68 and safe the context in a file called "mc19ad.f" .
    69 
    70 For neither MA27 or MC19 it is necessary to download any dependencies.
    71 
    72 If you want to use MA57, please make sure that all source code for
    73 MA57 ***including dependencies*** is in a file called ma57ad.f.
    74 (By using the button "Download HSL depencies" on the ma57 download
    75 page you can obtain everything already packed into one single file.)
    76 Currently, the dependencies are the files:
    77 
    78  fd15ad.f
    79  mc21ad.f
    80  mc34ad.f
    81  mc47ad.f
    82  mc59ad.f
    83  mc64ad.f
    84  mc71ad.f
    85 
    86 plus possibly a dummy file (metis.f) for METIS.  However, it is
    87 strongly suggested that you use METIS (look at the ThirdParty/Metis
    88 directory for instructions, or use the --with-metis configure flag to
    89 specify a procompiled Metis library).
    90 
    91 
    92 Instructions on where to put the source code:
    93 ---------------------------------------------
    94 
    95 Copy the source files for the required HSL routines into this
    96 directory before running the `configure' script.  The configuration
    97 script will detect which source files you have and prepare the
    98 Makefile accordingly.
    99 
     54Note, that in difference to previous versions of ThirdParty/HSL, the
     55configure script now checks for the HSL routines in subdirectories
     56as they are given in the coinhsl-x.y.z.tar.gz archive.
    10057
    10158Compiling a shared library with HSL
     
    13289
    133901. Put the HSL routines that are available to you into this directory
    134    (see above for the proper names, and how to get them).
     91   (see above).
    13592
    136932. Run the configure script of ThirdParty/HSL (not the one in the
Note: See TracChangeset for help on using the changeset viewer.