NAG Fortran Library, Mark 19

FLSOL19DAL - License Managed

Sun SPARC Solaris Double Precision

Installer's Note



Contents


1. Introduction

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

Whenever the NAG Fortran Library has been supplied in compiled form, that form is considered to be the standard library file. The use of all supplied software must be in accordance with the terms and conditions of the Software Licence signed by NAG and each site. Any request to use NAG software on a computer other than the one licensed must be referred to NAG (see Section 6).

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:         all SPARC systems
operating system: Solaris 2.6 or compatible
Fortran compiler: Sun Fortran 77 v5.0 or compatible

For information about implementations of the NAG Fortran Library 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:         Sun Ultra Enterprise 
operating system: Solaris 2.6
Fortran compiler: Sun Fortran 77 v5.0
compiler options: -O4 -fsimple=1 -dalign

The entire NAG Fortran Library, Mark 19, was compiled with full optimization (-O4) except for routine F07BDF which had to be compiled without optimization for the library libnag.so.19.

The libraries libnag.so.19 and libnag-spl.so.19 were also compiled with the additional flags -mt -PIC -stackvar.

The -dalign flag must always be used when compiling an application which is to be linked with one of the NAG object libraries. When linking a multi-threaded driver with the library, the -mt and -stackvar flags must also be used.

The libnag.a and libnag.so.19 object libraries have 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). The libnag-spl.a and libnag-spl.so.19 object libraries do not contain BLAS/LAPACK entries and were tested using the SPARC-specific BLAS/LAPACK routines in the (optional) Sun Performance Library (v5.0).

3. Distribution Medium

3.1. Recording Details

The implementation is distributed in tar format on CD-ROM, unless otherwise indicated on the medium and accompanying despatch note.

For further details, refer to other documentation supplied or contact NAG (see Section 6).

3.2. Contents

The following shows the directory/file organization of the materials as they will be installed.
                      |-- in.html
                      |-- un.html
                      |-- nag_fl_un.3
                      |-- essint
                      |-- summary
            |-- doc --|-- news
            |         |-- replaced
            |         |-- calls
            |         |-- called
            |         |-- blas_lapack_to_nag
            |         |-- nag_to_blas_lapack
flsol19da --|
            |-- libnag.a (compiled static library -- NAG BLAS/LAPACK)
            |-- libnag.so.19 (compiled dynamic library -- NAG BLAS/LAPACK)
            |-- libnag-spl.a (compiled static library -- no BLAS/LAPACK)
            |-- libnag-spl.so.19 (compiled dynamic library -- no BLAS/LAPACK)
            |
            |              |-- source ---|-- ??????e.f
            |-- examples --|-- data -----|-- ??????e.d
            |              |-- results --|-- ??????e.r
            |
            |              |-- bin ------|-- * (directories of FLEXlm binaries 
            |              |                    for supported platforms)
            |-- license ---|
            |              |             |-- flexfaq ---|-- *.htm (FLEXlm FAQ)
            |              |-- htmlman --|                         
            |                            |-- flexuser --|-- *.htm (FLEXLM End 
            |                                                      User Manual)
            |
            |-- scripts ---|-- *

3.3. File Sizes

The files require approximately the following disk space:
compiled libraries, libnag.a:         19.3 Mb
                    libnag.so.19:     12.7 Mb
                    libnag-spl.a:     19.1 Mb
                    libnag-spl.so.19: 13.0 Mb
example program material:              5.9 Mb
documentation files:                   2.5 Mb
licensing materials:                  16.1 Mb

4. Library Installation

4.1. Installation

To install all material use the Unix tar utility, e.g.

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

A site may not need to install all four of the object libraries provided in this distribution. After installing all material as described above, you may wish to delete some material if it is not required.

To decide which is the most suitable object library for your site, determine:

The static and shareable versions of all libraries are functionally equivalent. Sites should determine whether they prefer one type of library to the other. The advantages (briefly) of using static libraries are: The main advantage of using a dynamic library is that executables are kept significantly smaller.

After taking the above remarks into consideration, you may decide to delete some of the libraries.

The object libraries (libnag.a, libnag.so.19, etc.) should be moved to a directory, such as /usr/lib, in the default search path of the linker, if possible, so that linkage is convenient. If you decided to install the shareable versions of the libraries, then once the libraries are in place symbolic links should be made to point to the shareable libraries, e.g.

ln -s libnag.so.19 libnag.so
ln -s libnag-spl.so.19 libnag-spl.so
Unless this is done, the linker, ld, will not be able to find the shareable libraries.

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, should be moved to a directory in the man search path, e.g.

cd doc
mv nag_fl_un.3 /usr/local/man/man3

4.2. 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 7.0 of FLEXlm. The remainder of this section describes how a FLEXlm license key should be installed to enable the use of the Library. Further details about FLEXlm and how it may be configured to suit your local circumstances are included in the FLEXlm End User Manual and FAQ supplied in the directory flsol19da/license/htmlman.

For the NAG Fortran Library you will be provided with an uncounted license key for use on a specific machine.

An uncounted license key consists of one FEATURE or INCREMENT line for each product licensed, for example:

FEATURE NAG_FL NAG 19.000 31-jul-2000 0 CBDA2041DC1BC45D2B68 \
               "SOLA," 80896b27

This enables an unlimited number of instances of version 19 of the application NAG_FL until the date specified on the system with hostid 80896b27 only. Note that the line is continued by escaping the newline character with '\'.

You will have to inform NAG of the hostid of the system. To obtain the hostid, locate the FLEXlm utility program 'lmutil' in flsol19da/license/bin/sun4_u5, and run it with argument 'lmhostid'.

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.

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, G05FFF and X03AAF. The installation can also be tested using the script nagexample.

If the user advice refers to more than one compiled NAG library then each should be checked as above. 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 Section 3.1). 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:

doc/essint
doc/summary
doc/news
doc/replaced
doc/calls
doc/called
doc/blas_lapack_to_nag
doc/nag_to_blas_lapack
one or more of the compiled libraries:
libnag.a
libnag.so (symbolic link pointing at libnag.so.19)
libnag-spl.a
libnag-spl.so (symbolic link pointing at libnag-spl.so.19)
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 19, 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 currently provided with a printed copy of the NAG Fortran Library Manual (or Update) and 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 the Readme file on the distribution medium for further information.

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 please quote your NAG site reference and NAG product code (in this case FLSOL19DA).

(c) NAG Websites

The NAG websites are an information service providing items of interest to users and prospective users of NAG products and services. The information is reviewed and updated regularly and includes implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at

http://www.nag.co.uk/

or

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 you may want to register to receive our electronic newsletter, which will alert you to special offers, announcements about new products or product/service enhancements, case studies 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. We have provided a short survey on our website at www.nag.co.uk/local/feedback to enable you to provide this feedback. Alternatively feel free to contact the appropriate NAG Response Centre who will be happy either to record your comments or to send you a printed copy of the survey.

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

[NP3454/IN - License Managed]