NAG fl90, Release 4

FNLUX04DEL - License Managed

x86-32 Linux, Intel Fortran, Double Precision

Installer's Note



Contents


1. Introduction

This Installer's Note is essential reading for whoever is responsible for the installation of this implementation of the fl90 Library. It is available together with the Users' Note (un.html) on the distribution medium.

Your attention is drawn to the terms and conditions of the Software License regarding the use of NAG software. Any request to use this software other than on the licensed computer must be referred to NAG, as should requests for information about the availability of other implementations.

2. Implementation Provided

2.1. Applicability

This implementation is a compiled, tested, ready-to-use version of the NAG fl90 that is considered suitable for operation on the computer systems detailed below:

hardware:         Intel 32-bit systems
operating system: Linux Red Hat 9 Kernel 2.4.20-8 (Shrike, glibc-2.3.2-11.9) and compatible
                  (including RHEL4 Kernel 2.6.9-5.EL (Nahant, glibc-2.3.4-2))
Fortran compiler: Intel Fortran Compiler for 32-bit applications,
                  Version 8.1 and compatible (including versions 9.0 and 9.1)

2.2. Derivation

This implementation was produced at NAG Ltd., Oxford on the computing system detailed below:

hardware:          Intel Pentium 4
operating system:  Linux 2.4.20-8 (Red Hat Linux release 9 (Shrike))
Fortran compiler:  Intel(R) Fortran Compiler for 32-bit applications, Version 8.1
                   Build 20060606Z Package ID: l_fc_pc_8.1.034
The entire NAG fl90 library, Release 4, was compiled with full optimizaion (-O4), except for the following procedures, which had to be compiled at lesser optimization levels:
d03fay_7dt (-O0)
This library has been tested using the Basic Linear Algebra Subprograms (BLAS) and linear algebra routines (LAPACK) provided by NAG.

The library has been also tested with MKL version 8.1 (l_mkl_p_8.1.014). The MKL version 8.1 libraries are supplied as a part of this product (see contents).

The library has been also tested with version 9.0 (Build 20050912Z Package ID: l_fc_c_9.0.027) and version 9.1 (Build 20060323Z Package ID: l_fc_p_9.1.032) of the Intel compiler.

The library has been also tested using the Red Hat Enterprise Linux WS release 4 (Nahant) operating system (Kernel 2.6.9-5.ELsmp with glibc glibc-2.3.4-2).

3. Distribution Medium

The software is ordinarily distributed in tar format on CD-ROM, it can also be downloaded from any of the NAG Web sites (see NAG Websites).

3.1. Contents

The following shows the directory/file organization of the implementation materials as they will be installed.
            |- doc -|- in.html  (Installer's Note, (this document))
            |       |- un.html  (Users' Note)
            |
            |       |- libnagfl90_nag.a  (static self-contained library
            |       |                     including NAG BLAS/LAPACK)
            |- lib -|- libnagfl90_nag.so (shareable self-contained library
            |       |                     including NAG BLAS/LAPACK)
            |       |- libnagfl90_mkl.a  (static library requiring
            |       |                     MKL BLAS/LAPACK)
            |       |- libnagfl90_mkl.so (shareable library requiring
            |                             MKL BLAS/LAPACK)
fnllu04del -|
            |- nagfl90_modules -|- *.mod
            |
            |            |- source --|- *.f90
            |- examples -|- data ----|- *.dat
            |            |- results -|- *.r
            |
            |- scripts -|- nagfl90_example*
            |
            |- mkl_32 -|- * (Intel Math Kernel Library)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

The following shows the directory/file organization of the Library documentation materials as they will be installed.

                      |- release4.html  (main index)
                      |- genint  ----------|- *.html  (introductory
                      |                                material)
             |- html -|- library_contents -|- *.html
             |        |- images  ----------|- *.gif
             |        |- [c01-c29]_*.html  (chapter indexes)
             |
             |        |- library_contents -|- *.pdf
nagdoc_fn04 -|        |- genint  ---|- *.pdf  (introductory material)
             |- pdf  -|- indexes  --|- *.pdf  (KWIC and GAMS)
             |        |- [c01-c29] -|- *.pdf  (chapter, module and
             |                                  procedure files)
             |
             |- examples -|- source -|- *.f90
                          |- data  --|- *.dat

3.2. File Sizes

The files require approximately the following disk space:
compiled libraries:
  libnagfl90_nag.a            12.1 Mb
  libnagfl90_nag.so           10.3 Mb
  libnagfl90_mkl.a             8.7 Mb
  libnagfl90_mkl.so            7.5 Mb
module information files:      9.5 Mb
MKL (8.1) for IA32 libraries: 92.6 Mb
example program material:      4.3 Mb
scripts:                      17.0 Kb
library documentation files:  45.0 Kb
manual documentation files:   22.1 Mb
licensing materials:           2.2 Mb

4. Installation

4.1. Library and Documentation Installation

This section provides two ways of installing the libraries, documentation and other material provided. In future the manual installation section may be removed.

4.1.1. Installation using install script

You can install the materials from the CD or download directory by executing the Bourne Shell script install in a command window as:
./install.sh
By default, the materials will be installed in /opt/NAG/ or /usr/local/NAG/ depending on your system. The installer may choose a different location. In this document we refer to the directory /opt/NAG/fnlux04del or /usr/local/NAG/fnlux04del as [INSTALL_DIR].

The directory [INSTALL_DIR] is referenced in the Users' Note (un.html).

The directory [INSTALL_DIR]/scripts contains one or more scripts to show how to use the libraries provided with this implementation. See Users' Note, Example Programs. Subsequent to the installation, if the installer moves the library to some other location then these scripts must be changed to reflect that fact.

To simplify access to the libraries you may wish to create symbolic links in a system location such as /usr/lib pointing at the installed libraries. They would then be in the default search path of the linker during the link phase, and be available for execution at run time (in the case of shareable libraries). Note that if both the static and shareable version of a library are placed in a directory then the shareable version is usually used by default.

The module information files nagfl90_modules/*.mod are supplied in pre-compiled module form.

The -Ipathname option should then be specified on each compiler invocation (where pathname is [INSTALL_DIR]/nagfl90_modules) to tell the compiler where to find the modules.

To simplify the compiler invocation you could add the -Ipathname to the default system configuration file or use a personal configuration file and the environment variable IFORTCFG (for more details see the compiler documentation). In this case you will not need the -Ipathname when you invoke the compiler, you could also remove the -Ipathname from the nagfl90_example* scripts provided in the directory [INSTALL_DIR]/scripts.

The install script can install the Library documentation material in the same location as the NAG Library material or at some other location of the installer's choice.

You may wish to move the Library documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users.

4.1.2. Manual Installation

The libraries can be installed manually by following the instructions below:

Use the tar utility to extract the materials, e.g.

tar xvf /cdrom/fn04.tar
(assuming the CD-ROM has been mounted as /cdrom).

Each library is provided in both static and shareable format. You also have a choice of libraries; self contained libraries which use NAG supplied BLAS and LAPACK or libraries which require the use of MKL supplied BLAS and LAPACK. You may choose to install some or all of the libraries.

To simplify access to the libraries you may wish to create symbolic links in a system location such as /usr/lib pointing at the installed libraries. Then they would be in the default search path of the linker during the link phase, and be available for execution at run time (in the case of shareable libraries). Note that if both the static and shareable version of a library are placed in a directory then the shareable version is usually used by default.

To install the Library documentation material manually, use the tar utility, e.g.

tar xvf /cdrom/fn04_doc.tar
(assuming the CD-ROM has been mounted as /cdrom).

You may wish to move the Library documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users.

The module information files nagfl90_modules/*.mod are supplied in pre-compiled module form.

The -Ipathname option should then be specified on each compiler invocation (where pathname is [INSTALL_DIR]/nagfl90_modules) to tell the compiler where to find the modules.

To simplify the compiler invocation you could add the -Ipathname to the default system configuration file or use a personal configuration file and the environment variable IFORTCFG (for more details see the compiler documentation). In this case you will not need the -Ipathname when you invoke the compiler.

The directory [INSTALL_DIR]/scripts contains one or more scripts to show how to use the libraries provided with this implementation. These scripts refer to the local directory containing the example programs. The files should be copied to (for example) /usr/local/bin, modified to reflect the local installation, and their protection set to world execute. If you added the -Ipathname to the default system configuration file or use a personal configuration file and the environment variable IFORTCFG you could also remove the -Ipathname from these scripts.

To install the Library documentation material manually, use the tar utility, e.g.

tar xvf /cdrom/fn04_doc.tar
(assuming the CD-ROM has been mounted as /cdrom).

You may wish to move the Library documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users.

4.1.3. License Management

The use of the NAG Fortran Library is controlled by the Kusari network license management system. This release of the NAG Fortran Library uses version 2.1 of Kusari.

In order to enable the software, NAG will issue you with a license key. The license key is a simple text file containing details of the software that will be enabled.

To request a license key, run the program khostid located in the license/bin/linux/ subdirectory of the software distribution. This utility must be run from a command prompt. Return the information that it displays by e-mail (or FAX) to NAG.

A short term (demonstration or trial) license key contains one or more lines like the following:

FNLUX04DE TRIAL 2006/9/9 "EMnxidA3oeoj0F1Yvi5ibxPjB7"
Specifically, it has a line containing the word TRIAL and is referred to here as an uncounted license key. Longer term uncounted license keys must be locked to a specific computer, i.e. they will enable the software on one computer only. These license keys include the word NODE instead of the word TRIAL above. Other types of keys may also be issued.

Once you have obtained the license key, store the text of it in a file, say [INSTALL_DIR]/license.lic.

For an uncounted license, the location of the license file must be made known to the NAG application by setting the environment variable NAG_KUSARI_FILE to the full pathname of the file before the application is invoked.

For example, in the C-shell, type:

   setenv NAG_KUSARI_FILE [INSTALL_DIR]/license.lic
or in the Bourne shell, type:
   NAG_KUSARI_FILE=[INSTALL_DIR]/license.lic
   export NAG_KUSARI_FILE
No other actions are required to install an uncounted license.

Further details about Kusari and how it may be configured to suit your local circumstances are included in the Kusari Licence Management User Guide.

4.2. Release to Users

The Users' Note (un.html) should be checked and amended as necessary (particularly Section 3.1, 3.2 and 5). It can then be made available to users directly, or be absorbed into local access information.

The following material should also be made accessible to users:

documentation files:

The nagdoc_fn04 directory contains the online documentation. This should be made available to users, in addition to the following:

compiled libraries:

  libnagfl90_nag.a
  libnagfl90_nag.so
  libnagfl90_mkl.a
  libnagfl90_mkl.so
MKL libraries supplied by NAG
  mkl_32/*
module information files:
  nagfl90_modules/*.mod
example program material:
  examples/source/*.f90
  examples/data/*.dat
  examples/results/*.r
  scripts/nagfl90_example*

Note that the example material has been adapted, if necessary, from that published in the NAG fl90 Manual, so that programs are suitable for execution with this implementation with no further changes (but see Section 4.3.1 for comments about possible differences in results obtained). Making the example material directly available to users provides them with easily adaptable templates for their own problems.

4.3. Further Information

For best performance we recommend that you should use the variant of the NAG fl90 Library which is based on the supplied MKL library i.e. libnagfl90_mkl.a or libnagfl90_mkl.so. However if you use a version of the MKL library different from the version used in creating this implementation and you have problems when calling a NAG routine, we suggest that you use the self-contained libraries libnagfl90_nag.a or libnagfl90_nag.so.

4.3.1. Example Programs

The example results distributed were generated at Release 4, using the software described in Section 2.2. These example results may not be exactly reproducible if the example programs are run in a slightly different environment (for example, a different Fortran compiler, a different compiler library, or a different set of BLAS or LAPACK routines). The results which are most sensitive to such differences are: eigenvectors (which may differ by a scalar multiple, often -1, but sometimes complex); numbers of iterations and function evaluations; and residuals and other "small" quantities of the same order as the machine precision.

4.3.2. Maintenance Level

The maintenance level of the library can be determined by writing a simple program to call procedure nag_lib_ident or you could call the script nagfl90_example with the argument nag_lib_support_ex01. See Users' Note, Example Programs . This example prints out details of the implementation, including title and product code, compiler and precision used, release and maintenance level.

5. Documentation

On-line documentation is bundled with this implementation. Please see Section 4.

6. Support from NAG

(a) Contact with NAG

Queries concerning this document or the implementation generally should be directed initially to your local Advisory Service. If you have difficulty in making contact locally, you can contact NAG directly at one of the addresses given in the Appendix. Users subscribing to the support service are encouraged to contact one of the NAG Response Centres (see below).

(b) NAG Response Centres

The NAG Response Centres are available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.

The Response Centres are open during office hours, but contact is possible by fax, email and phone (answering machine) at all times.

When contacting a Response Centre it helps us deal with your enquiry quickly if you can quote your NAG site reference and NAG product code (in this case FNLUX04DEL).

(c) NAG Websites

The NAG websites provide information about implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at the following URLs:

http://www.nag.co.uk/, http://www.nag.com/ or http://www.nag-j.co.jp/

(d) NAG Electronic Newsletter

If you would like to be kept up to date with news from NAG then please register to receive our free electronic newsletter, which will alert you to special offers, announcements about new products or product/service enhancements, customer stories and NAG's event diary. You can register via one of our websites, or by contacting us at nagnews@nag.co.uk.

(e) Product Registration

To ensure that you receive information on updates and other relevant announcements, please register this product with us. For NAG Library products this may be accomplished by filling in the online registration form at http://www.nag.co.uk/numeric/Library_Registration.asp.

7. User Feedback

Many factors influence the way NAG's products and services evolve and your ideas are invaluable in helping us to ensure that we meet your needs. If you would like to contribute to this process we would be delighted to receive your comments. Please contact any of the NAG Response Centres (shown below).

Appendix - Contact Addresses

NAG Ltd
Wilkinson House
Jordan Hill Road
OXFORD  OX2 8DR                         NAG Ltd Response Centre
United Kingdom                          email: support@nag.co.uk

Tel: +44 (0)1865 511245                 Tel: +44 (0)1865 311744
Fax: +44 (0)1865 310139                 Fax: +44 (0)1865 310139

NAG Inc
1431 Opus Place, Suite 220
Downers Grove
IL 60515-1362                           NAG Inc Response Center
USA                                     email: support@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2337
Fax: +1 630 971 2706                    Fax: +1 630 971 2706

Nihon NAG KK
Hatchobori Frontier Building 2F
4-9-9
Hatchobori
Chuo-ku
Tokyo
104-0032
Japan
email: help@nag-j.co.jp

Tel: +81 (0)3 5542 6311
Fax: +81 (0)3 5542 6312