NAG Fortran Library, Mark 20

FLSO620DA

Sun UltraSPARC 64 bit Solaris 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:         all SPARC Ultra systems
operating system: Solaris 7 and 8 or compatible
Fortran compiler: Sun Forte (Workshop 6, f77, f90, f95) and compatible
This implementation is not suitable for creating multi-threaded applications: a separate implementation, FLSO620DT, is available for that purpose.

Note that, except for the two routines X04ACF and X04ADF, the libraries in this implementation are compatible with Sun Fortran 90/95, provided that the f90/95 compiler is called with the flag -lF77 (and not -lf77compat).

2.2. Derivation

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

hardware:         Sun UltraSPARC-5_10 and also tested using a Sun UltraSPARC-80
operating system: Solaris 8 (SunOS 5.8) and also tested using Solaris 7
Fortran compiler: Sun WorkShop 6 update 1 FORTRAN 77 5.2. Also tested using:
                  Sun WorkShop 6 update 1 Fortran 95 6.1 Patch 109503-05
                  (f90 is a link to f95)
                  Sun WorkShop 6 update 2 FORTRAN 77 5.3
                  Sun WorkShop 6 update 2 Fortran 95 6.2
compiler options: -dalign -xtarget=generic64 -PIC
                  -fsimple=1 -libmil -xlibmopt -depend -xprefetch=yes

The entire NAG Fortran Library, Mark 20, was compiled with the above compiler options and -O4 optimization, except for the auxiliary routines G05YAW, S17DER and Y90EBF which had to be compiled without loop dependency analysis (-nodepend). S17DER also had to be compiled at -O2 optimization, and Y90EBF had to be compiled with no optimization, and without the -fsimple=1 -libmil -xlibmopt -depend -xprefetch=yes compiler options.

The -dalign and -xarch=generic64 flags must always be used when compiling an application which is to be linked with one of the NAG object libraries.

The libnag.a and libnag.so.20 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.20 object libraries were tested using the SPARC-specific BLAS/LAPACK routines in the (optional) Sun Performance Library.

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 library materials as they will be installed.
                      |-- in.html
                      |-- un.html
            |-- doc --|-- nag_fl_un.3
            |         |-- blas_lapack_to_nag
            |         |-- nag_to_blas_lapack
flso620da --|
            |-- libnag.a (compiled static library including NAG BLAS/LAPACK)
            |-- libnag.so.20 (compiled dynamic library including NAG BLAS/LAPACK)
            |-- libnag-spl.a (compiled static library using Sun BLAS/LAPACK)
            |-- libnag-spl.so.20 (compiled dynamic library using Sun BLAS/LAPACK)
            |
            |-- interface_blocks --|-- *.mod
            |
            |              |-- source ---|-- ??????e.f
            |-- examples --|-- data -----|-- ??????e.d
            |              |-- results --|-- ??????e.r
            |
            |-- scripts ---|-- *

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:
compiled libraries, libnag.a:             28.4 Mb
                    libnag.so.20:         21.0 Mb
                    libnag-spl.a:         31.3 Mb
                    libnag-spl.so.20:     23.2 Mb
interface blocks:                          2.9 Mb
example program material:                  5.6 Mb
scripts:                                    40 Kb
library documentation files:                64 Kb
PDF documentation files:                   105 Mb

4. Installation

4.1. Library Installation

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

tar xvf /cdrom/fl20.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 dynamic (shareable) versions of these 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.20, 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.20 libnag.so
ln -s libnag-spl.so.20 libnag-spl.so
Unless this is done, the linker, ld, will not be able to find the shareable libraries.

If you do not wish to move the libraries to a system directory, you may use the -L and -R linker options instead.

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 modified to reflect the local installation, and moved to a directory in the man search path, e.g.

cd doc
mv nag_fl_un.3 /usr/local/man/man3
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/95 programs. Their purpose is to allow the Fortran 90/95 compiler to check that NAG Fortran Library routines are called correctly.

The interface block files (interface_blocks/*.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
mv interface_blocks/* /usr/local/lib/fl77_modules

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

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. Release to Users

The Users' Note (doc/un.html) should be checked and amended as necessary (particularly Sections 3.1 and 5.). Advice on accessing the library in Section 3.1 can be checked 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 Users' Note 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
one or more of the compiled libraries:
libnag.a
libnag.so (symbolic link pointing at libnag.so.20)
libnag-spl.a
libnag-spl.so (symbolic link pointing at libnag-spl.so.20)
interface block files:
interface_blocks/*.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 published in the NAG Fortran Library Manual, so that programs are suitable for execution with this implementation with no further changes (but see Section 4.4.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.4. Further Information

4.4.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.4.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.4.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 FLSO620DA).

(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

[NP3629/IN]