NAG fl90, Release 4

FNAI604DAL - License Managed

IBM Power Systems, 64-bit, AIX, xlf90

Installer's Note



Contents


1. Introduction

This document is essential reading for whoever is responsible for the installation of the NAG fl90 implementation specified in the title. The installer will be supplied with a printed copy of this document. Both this (in.html) and the Users' Note (un.html) are supplied in the doc directory and on the distribution medium.

Whenever the NAG fl90 has been supplied in compiled form, that form is considered to be the standard library file.

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 NAG fl90 that is considered suitable for operation on the computer systems detailed below:

hardware:         IBM Power5 64-bit systems or compatible
                   (including Power3 and power4)
operating system: AIX v5.3 or compatible
Fortran compiler: IBM xlf90 v9.1 or compatible

For information about implementations of NAG fl90 for use on other computer systems please contact NAG.

2.2. Derivation

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

hardware:         IBM Power5 system
operating system: AIX v5.3
Fortran compiler: IBM xlf90 version 9.1.0.0
compiler options: -q64 -O3 -qstrict -w -u -qarch=pwr3 -qtune=pwr4 -qnosave -qthreaded

The entire NAG fl90 library, Release 4, was compiled with optimization level (-O3 -qstrict), except for the following procedure, which had to be compiled with less optimization level:

f06ref_9d (-O0)    f06uhf_9d (-O0)    f06ujf_9d (-O0)    f07tax_9d (-O0)
f07tox_9d (-O0)    f11ubf_9d (-O0)    f08aff_9d (-O0)    f08atf_9d (-O0)
f08kef_9d (-O0)    f08ksf_9d (-O0)    f08maf_9d (-O0)    f08ntf_9d (-O0)
f08nwf_9d (-O0)    x04cgf_9d (-O0)
The Library can be used with or without the compiler flag -qextname.

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 IBM BLAS and the Engineering and Scientific Subroutine Library ESSL v4.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 library 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_essl.a  (static library requiring
            |       |                      IBM BLAS/LAPACK)
            |       |- libnagfl90_essl.so (shareable library requiring
fnai604dal -|                              IBM BLAS/LAPACK)
            |- nagfl90_modules -|- *.mod
            |
            |            |- source --|- *.f90
            |- examples -|- data ----|- *.dat
            |            |- results -|- *.r
            |
            |- scripts -|- nagfl90_example*
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (Installation and User Guides)

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

             |- images -|- *.gif
             |
             |               |- release4.html  (main index)
             |               |
             |               |- genint -|- *.html  (introductory material)
nagdoc_fn04 -|      |- html -|
             |      |        |- library_contents -|- *.html
             |      |        |
             |      |        |- [c01-c29]_fn04.html  (chapter indexes)
             |- fn -|
                    |       |- genint -|- *.pdf  (introductory material)
                    |       |
                    |       |- library_contents -|- *.pdf
                    |- pdf -|
                            |- indexes -|- *.pdf  (KWIC and GAMS)
                            |
                            |- [c01-c29] -|- *.pdf  (chapter, module
                                                     and procedure files)

3.2. File Sizes

The files require approximately the following disk space:
compiled libraries:
  libnagfl90_nag.a     29.3 Mb
  libnagfl90_nag.so    24.3 Mb
  libnagfl90_essl.a    28.6 Mb
  libnagfl90_essl.so   23.6 Mb
                                                                                
module information files:    11.1 Mb
example program material:     1.8 Mb
scripts:                     13.0 Kb
library documentation files: 40.0 Kb
manual documentation files:  20.2 Mb
licensing materials           1.1 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/fnai604dal or /usr/local/NAG/fnai604dal 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 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.

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

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

Alternatively, you could update the IBM xlf configuration file (the default is /etc/xlf.cfg) or create your own copy of xlf.cfg to include the -Ipathname. For more details see the IBM XL Fortran for AIX User's Guide.

In the scripts provided and in the Users' Note (un.html) we use files with extension f90 and invoke the compiler using xlf90_r. Please ensure that suffix = f90 is part of the setting in the "xlf90_r" section within the IBM xlf configuration file to be used (the default is /etc/xlf.cfg).

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 vendor 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 f90/f95 invocation (where pathname is [INSTALL_DIR]/nagfl90_modules) to tell the compiler where to find the modules.

Alternatively, you could update the IBM xlf configuration file (the default is /etc/xlf.cfg) or create your own copy of xlf.cfg to include the -Ipathname. For more details see the IBM XL Fortran for AIX User's Guide.

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.

In the scripts provided and in the Users' Note (un.html) we use files with extension f90 and invoke the compiler using xlf90_r. Please ensure that suffix = f90 is part of the setting in the "xlf90_r" section within the IBM xlf configuration file to be used (the default is /etc/xlf.cfg).

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.0 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/aix64/ 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:

FNAI604DAL TRIAL 2005/11/12 "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_essl.a
  libnagfl90_essl.so
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 printed in the NAG fl90 Manual, so that programs are suitable for execution with this implementation with no further changes. 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 IBM ESSL/BLAS libraries i.e. libnagfl90_essl.a or libnagfl90_essl.so. However if you use versions of the ESSL/BLAS libraries different from the versions 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, different arithmetic hardware, 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, which 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 FNAI604DAL).

(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.

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: infodesk@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2345
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