NAG Fortran Library, Mark 20

FLSG620DAL - License Managed

Silicon Graphics (IRIX 6) 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 NAG Fortran Library. It is supplied in printed form to accompany the software, and is also available together with the Users' Note (un.html) in the doc directory on the distribution medium.

Your attention is drawn to the terms and conditions of the Software Licence 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 Fortran Library that is considered suitable for operation on the computer systems detailed below:

hardware:         Silicon Graphics MIPS III or MIPS IV
operating system: IRIX 6.5 or compatible
Fortran compiler: SGI MIPSpro 7.3.1.2 Fortran 77 or Fortran 90
Note, however, that the two routines X04ACF and X04ADF are not compatible with Fortran 90.

2.2. Derivation

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

hardware:         Silicon Graphics Origin 3400
operating system: IRIX 6.5
Fortran compiler: SGI MIPSpro 7.3.1.2
compiler options: -n32 -mips3 (for MIPS III ISA / n32 ABI)
                  -n32 -mips4 (for MIPS  IV ISA / n32 ABI)
                  -64  -mips3 (for MIPS III ISA / n64 ABI)
                  -64  -mips4 (for MIPS  IV ISA / n64 ABI)

The entire NAG Fortran Library, Mark 20, was compiled with full optimization (-O3), except for the following routines, which had to be compiled with -O2 optimization:

c06fpst.f  d02qfvt.f  d06daft.f  f02bjxt.f  x03aayt.f
d02nmxt.f  d06cbst.f  d52qfvt.f  g13fgtt.f

This library has been tested using the Basic Linear Algebra Subprograms (BLAS) and linear algebra routines (LAPACK) provided by NAG (see the Chapter Introductions for F06, F07 and F08 in the NAG Fortran Library Manual). It has also been tested using the set of BLAS and LAPACK routines supplied by Silicon Graphics in the SGI Scientific Computing Software Library (SCSL) version 1.3.0.0.

3. Distribution Medium

The software is ordinarily distributed in tar format on CD-ROM.

3.1. Contents

The following shows the directory/file organization of the materials as they will be installed.
                       |-- in.html
                       |-- un.html
             |-- doc --|-- nag_fl_un.3
             |         |-- blas_lapack_to_nag
             |         |-- nag_to_blas_lapack
             |
             |-- lib[32|64] --|-- mips[3|4] --|-- *
flsg620dal --|
             |-- interface_blocks_lib[32|64] --|-- *.mod
             |
             |              |-- source ---|-- ??????e.f
             |-- examples --|-- data -----|-- ??????e.d
             |              |-- results --|-- ??????e.r
             |
             |-- scripts ---|-- *
             |
             |              |-- bin ------|-- * (directories of FLEXlm binaries
             |              |                    for supported platforms)
             |-- license ---|-- README.TXT
                            |
                            |-- htmlman --|-- flexuser --|-- * (End User Guide)

Each of the library directories (lib32/mips3,lib32/mips4,lib64/mips3,lib64/mips4) contains four libraries:

libnag.a      - archive library
libnag.so     - shareable library
libnag_scs.a  - archive library requiring SCSL Scientific Library
libnag_scs.so - shareable library requiring SCSL Scientific Library

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

NAGdoc -|- fl -|- html -|- mark20.html (main index)
               |        |
               |        |- frontmatter -|- *.html (sundry information)
               |        |
               |        |- genint -|- *.html (introductory material)
               |        |
               |        |- images -|- *.gif (nag images)
               |        |          |
               |        |          |- topbar -|- *.gif (Fortran Library images)
               |        |
               |        |- indexes -|- gams -|- gams.html (main GAMS index)
               |        |           |        |
               |        |           |        |- *.html (GAMS files)
               |        |           |
               |        |           |- kwic -|- kwic.html (main KWIC index)
               |        |                    |
               |        |                    |- *.html (KWIC files)
               |        |
               |        |- toc -|- [A02-X05].html (chapter indexes)
               |                                                  
               |- pdf  -|- genint -|- *.pdf (introductory material)
               |        |
               |- [A02-X05] -|- *.pdf (chapter and routine files)

3.2. File Sizes

The files require approximately the following disk space:
each archive library:         33 - 37 Mb
each shareable library:       19 - 24 Mb
interface blocks:                6    Mb
example program material:        7    Mb
library documentation files:    90    kb
PDF documentation files:       107    Mb
licensing materials             25    Mb

4. Installation

4.1. Library Installation

To install all material, use the Unix tar utility, e.g.
cd /opt
tar xvf /cdrom/fl20.tar
(assuming the CD-ROM has been mounted as /cdrom).

The installer should decide on which of the eight archive and the eight corresponding shareable libraries should be installed. To install all primary material (to be made available to users), use the Unix tar utility to read documentation, license daemons, compiled libraries, interface blocks and examples, e.g.

cd /opt
tar xvf /cdrom/fl20.tar flsg620dal/doc flsg620dal/license \
                        flsg620dal/lib32/mips4 \
                        flsg620dal/interface_blocks_lib32 \
                        flsg620dal/examples flsg620dal/scripts/nagexample
for the MIPS IV / n32 libraries.

It is advisable that the libraries are kept in the installed directory, /opt/flsg620dal/, and appropriate symbolic links `libnag.a', `libnag.so', `libnag_scs.a' and `libnag_scs.so' made to them from appropriate system library directories where the linker (ld) will find them, e.g., for the MIPS IV / n32 libraries.

ln -s /opt/flsg620dal/lib32/mips4/libnag.a  /usr/lib32/mips4/libnag.a
ln -s /opt/flsg620dal/lib32/mips4/libnag.so /usr/lib32/mips4/libnag.so
ln -s /opt/flsg620dal/lib32/mips4/libnag_scs.a  /usr/lib32/mips4/libnag_scs.a
ln -s /opt/flsg620dal/lib32/mips4/libnag_scs.so /usr/lib32/mips4/libnag_scs.so

For the MIPS III / n32 libraries, an appropriate directory is /usr/lib32/mips3; for the MIPS III and MIPS IV / n64 libraries appropriate directories are /usr/lib64/mips3 and /usr/lib64/mips4, respectively.

The script nagexample refers to the local directory containing the example programs. The file should be copied to (for example) /usr/local/bin, modified to reflect the local installation, and its protection set to world execute.

The man page, which directs users to the HTML form of the Users' Note, is provided as an nroff source file and also as a packed, pre-formatted file for systems without the Documentor's Work Bench software option. The relevant file belongs in section 3 of man. It should be modified to reflect the local installation, and moved a directory in the man search path, e.g.

either

cd doc
mv nag_fl_un.3 /usr/local/man/man3
or
cd doc
mv nag_fl_un.z /usr/local/man/cat3

The NAG Fortran Library Interface Blocks define the type and arguments of each user callable NAG Fortran Library routine. These are not essential to calling the NAG Fortran Library from Fortran 90 programs. Their purpose is to allow the Fortran 90 compiler to check that NAG Fortran Library routines are called correctly.

The interface block files (interface_blocks_lib32/*.mod and interface_blocks_lib64/*.mod) are supplied in pre-compiled module form. They should be moved to a suitable location so that access is convenient, e.g.

mkdir /usr/local/lib/fl77_modules_lib32
mv interface_blocks_lib32/* /usr/local/lib/fl77_modules_lib32
 
mkdir /usr/local/lib/fl77_modules_lib64
mv interface_blocks_lib64/* /usr/local/lib/fl77_modules_lib64

The -I"pathname" option should then be specified on each f90 invocation (where "pathname" is /usr/local/lib/fl77_modules_lib32 or /usr/local/lib/fl77_modules_lib64) to tell the compiler where to find the modules.

4.1.1. License Management

The use of the NAG Fortran Library is controlled by the FLEXlm network license management system (FLEXlm is a registered trademark of Globetrotter Software Inc). This release of the NAG Fortran Library uses version 8.1b of FLEXlm.

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

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

FEATURE NAG_FL NAG 20.000 10-apr-2002 0 CBDA2041DC1BC45D2B68 "ANY" DEMO
Specifically, it does not have any lines starting with the word SERVER 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 FLEXlm hostid of the computer instead of the word DEMO above.

To apply for a longer term license key, contact one of the NAG Response Centres quoting the product to be licensed and the FLEXlm hostid for the computer. To obtain the FLEXlm hostid, select the appropriate lmutil program from the platform specific directory under the license/bin/ subdirectory, and run it with argument lmhostid e.g.:

license/bin/sgi32_u6/lmutil lmhostid
On systems without an ethernet card, use the arguments lmhostid -long.

Once you have obtained the license key, store the text of it in a file, say /usr/local/lib/nag/license.dat.

The location of this file must be made known to the NAG application by setting the environment variable LM_LICENSE_FILE to the full pathname of the file before the application is invoked.

For example, in the C-shell, type:

setenv LM_LICENSE_FILE /usr/local/lib/nag/license.dat
or in the Bourne shell, type:
LM_LICENSE_FILE=/usr/local/lib/nag/license.dat
export LM_LICENSE_FILE
No other actions are required to install an uncounted license.

Further details about FLEXlm and how it may be configured to suit your local circumstances are included in the FLEXlm End Users Guide supplied in the license/htmlman/flexuser/ subdirectory.

4.2. PDF Documentation Installation

To install all PDF documentation material, use the Unix tar utility, e.g.
tar xvf /cdrom/pdf.tar
(assuming the CD-ROM has been mounted as /cdrom).

You may wish to move the PDF documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users, but in such a way that they are not generally accessible from outside your site. Further information is contained in the readme file on the distribution medium.

4.3. Checking Accessibility

The installer should ensure that the advice given to users in Section 3.1 of the Users' Note (doc/un.html) is suitable for the installation. This can be done by running a few example programs following that advice; a suitable sample would be A02AAF, G05LFF and X03AAF. The installation can also be tested using the script nagexample.

The specific library used by the linker depends on the compilation options, if any, specified by the user and on the system processor. On systems such as the Silicon Graphics Power Indigo2, based on a R8000 processor, the default, if the SGI_ABI environment variable has not been set, is 64-bit and MIPS IV. On systems such as the Silicon Graphics Origin 2000, based on a R10000 processor, the default, if the SGI_ABI environment variable has not been set, is high performance 32-bit (-n32) and MIPS IV.

A script, runex, is supplied in the scripts directory, as part of the implementation. The script can be used for testing any of the installed libraries. In the script, the ABI and ISA must be specified in the variables STD and LD_LIBRARY_PATH.

Since several compiled NAG libraries are included in this implementation, it is advisable that each should be checked. If any externally provided library of Basic Linear Algebra Subprograms (BLAS) is to be used then the following example programs should also be run:

F06EAF - testing real Level 1 BLAS
F06GAF - testing complex Level 1 BLAS
F06ERF - testing real sparse Level 1 BLAS
F06GRF - testing complex sparse Level 1 BLAS
F06PAF - testing real Level 2 BLAS
F06SAF - testing complex Level 2 BLAS
F06YAF - testing real Level 3 BLAS
F06ZAF - testing complex Level 3 BLAS

Note that the last four example programs take longer to execute than the average example program. The Users' Note may contain extra information needed when running these tests.

4.4. Release to Users

The Users' Note (doc/un.html) should be checked and amended as necessary (particularly Sections 3.1 and 5). It should 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 directory contains the online documentation. This should be made available to users, in addition to the following:

doc/blas_lapack_to_nag
doc/nag_to_blas_lapack
compiled libraries:
lib[32|64]/mips[3|4]/libnag.a
lib[32|64]/mips[3|4]/libnag.so
lib[32|64]/mips[3|4]/libnag_scs.a
lib[32|64]/mips[3|4]/libnag_scs.so
interface block files:
interface_blocks_lib[32|64]/*.mod
example program material:
examples/source/??????e.f
examples/data/??????e.d
examples/results/??????e.r
scripts/nagexample

Note that the example material has been adapted, if necessary, from that printed in the NAG Fortran Library Manual, so that programs are suitable for execution with this implementation with no further changes (but see Section 4.5.2 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.5. Further Information

4.5.1. Output Unit Dependencies (X04)

Certain NAG routines use explicit WRITE statements to produce output directly. The choice of output unit used can be controlled by using X04AAF and X04ABF, described in the NAG Fortran Library Manual. The defaults for this implementation are given in the Users' Note.

4.5.2. Example Programs

The example results distributed were generated at Mark 20, 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.

The "example programs" for the routines in the F06 chapter are not typical example programs and they are not in the Library Manual. They are test programs, which are supplied to sites for use in an installation test of the Library. Some of them take much longer to run than other example programs. Routines which are equivalent to BLAS, are tested twice: once when called by their NAG F06 names, and once when called by their BLAS names.

4.5.3. Maintenance Level

The maintenance level of the library can be determined by writing a simple program to call A00AAF, which prints out details of the implementation, including title and product code, compiler and precision used, mark and maintenance level.

5. Documentation

Each supported NAG Fortran Library site is ordinarily provided with a printed copy of the NAG Fortran Library Introductory Guide. Additional copies are available for purchase; please refer to the NAG documentation order form (available on the NAG websites, see Section 6 (c)) for details of current prices.

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

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 FLSG620DAL).

(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

http://www.nag.co.uk/, http://www.nag.com/ (in North America) or http://www.nag-j.co.jp/ (in Japan)

(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. To register simply visit one of our websites or contact 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 your local NAG Response Centre (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
Yaesu Nagaoka Building No. 6 
1-9-8 Minato
Chuo-ku
Tokyo
Japan
email: help@nag-j.co.jp

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

[NP3631/IN]