FLDVV20DA Installer's Note

NAG Fortran Library, Mark 20

FLDVV20DA

DEC VAX/VMS Double Precision

Installer's Note

1. Introduction
2. Implementation Provided
- 2.1. Applicability
- 2.2. Derivation
3. Distribution Medium
- 3.1. Contents
- 3.2. File Sizes
4. Installation
5. Documentation
6. Support from NAG
7. User Feedback
Appendix - Contact Addresses

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.bck save set on the distribution medium. The Installer's Note and the Users' Note are also supplied in plain text form (in.doc and un.doc in the doc.bck save set).

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 systems in the VAX range
operating system: VAX/VMS V5.5 or compatible
Fortran compiler: VAX Fortran

2.2. Derivation

This implementation was produced at the Computing Centre of Cardiff University on the computing system detailed below:

hardware:         DEC VAX-4200
operating system: VAX/VMS V5.5-2
Fortran compiler: VAX FORTRAN V5.9-173
Assembler:        VAX MACRO V5.4-3
compiler options: /OPTIMIZE /CHECK=(NOBOUNDS,OVERFLOW,NOUNDERFLOW)

and was also tested on the following system:

hardware:         DEC VAX-4600
operating system: VAX/OpenVMS V7.3
Fortran compiler: COMPAQ FORTRAN 77 V6.6-201

The entire NAG Fortran Library, Mark 20, was compiled with full optimization, except for the following routine, which had to be compiled unoptimized:

E54UCK

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

3. Distribution Medium

3.1. Contents

The information has been written on the release medium as a series of backup save sets.

The save set INSTALL.BCK contains the following files:

INSTALL.COM   - an installation command procedure
 
NAGSHARE.COM  - a command procedure used by INSTALL.COM to convert a NAG object 
                module library to shareable form
 
NAG$SHARE.MAR - a base transfer vector ensuring compatibility of the shareable 
                library across all customer sites

TRAVEC.COM    - a command procedure used by NAGSHARE.COM to convert the object 
                module library to a shareable library

TRALIB.EXE    - an executable module used by TRAVEC.COM

The save set DOC.BCK contains the following files:

IN.DOC        - the Installer's Note for this implementation in plain text form
 
UN.DOC        - the Users' Note for this implementation in plain text form
 
IN.HTML       - the Installer's Note for this implementation in HTML form

UN.HTML       - the Users' Note for this implementation in HTML form

ESSINT.DOC    - the Essential Introduction to the NAG Fortran Library

NEWS.DOC      - an outline of the new and enhanced routines available at Mark 20

CONTENTS.DOC  - a brief summary of the routines

WITHDRAWN.DOC - a concise list of routines available at earlier Marks of the
                Library but since withdrawn, together with recommended 
                replacements

REPLACED.DOC  - a detailed list of routines available at earlier Marks of the
                Library but since withdrawn, together with recommended
                replacements

BLAS_LAPACK_TO_NAG.DOC - BLAS/F06, LAPACK/F07 and LAPACK/F08 listing

NAG_TO_BLAS_LAPACK.DOC - F06/BLAS, F07/LAPACK and F08/LAPACK listing

The save set LIBRARY.BCK contains the following file:

NAG$LIBRARY.OLB - the NAG Fortran Library

The save set TEST.BCK contains the following files:

*.FOR - the Fortran source text of the example programs for F01ABF, F04ADF, 
        G05FFF and S17AKF
 
*.DAT - the data required to run the example programs for F01ABF, F04ADF and 
        S17AKF
 
*.RES - the results produced by the example programs for F01ABF, F04ADF, G05FFF 
        and S17AKF

The save set EXPT.BCK contains the following files:

*.FOR - the Fortran source text of the example programs

The save set EXPD.BCK contains the following files:

*.DAT - the data required to run the example programs

The save set EXPR.BCK contains the following files:

*.RES - the results produced by the example programs

3.2. File Sizes

The files require approximately the following disk space:

compiled library:                22600 blocks
(as supplied in compressed form)
example program material:        11100 blocks
documentation files:              1100 blocks

4. Installation

4.1. Library Installation

If you do not have a CD-ROM drive on your VAX/VMS system, the backup save sets can be FTPed (in binary form) from a drive on a PC or Unix system to your VAX/VMS system. In this case, in the installation instructions below, ignore the MOUNT and DISMOUNT commands but reset the file attributes of the backup save sets as follows:

$ SET FILE/ATTRIBUTE=(LRL:8192,RFM:FIX)  *.BCK

N.B. The MOUNT/MEDIA=CDROM/UNDEFINED_FAT=fixed:none:8192 and SET FILE/ATTRIBUTE=(LRL:8192,RFM:FIX) commands do not work under VAX/VMS V5.5. You will need to be running OpenVMS VAX V6.0 or compatible to mount the CD-ROM or reset the file attributes.

4.1.1. Library Installation, using INSTALL.COM

Mount the CD-ROM on a drive, e.g. DKA400:

$ MOUNT/MEDIA=CDROM/UNDEFINED_FAT=fixed:none:8192 DKA400:  FLDVV20DA

Use the BACKUP command to unpack the INSTALL.BCK save set, e.g.
```
$ BACKUP DKA400:[000000]INSTALL.BCK/SAVE_SET  []
```
Run the INSTALL command procedure
```
$ @INSTALL
```
This command procedure also gives you the option of
- converting an object module library into a shareable library
- running a small set of example programs
- unpacking the Fortran source text, data and results for all the example programs
Dismount the CD-ROM
```
$ DISMOUNT DKA400:
```

4.1.2. Object Module Library Installation, without using INSTALL.COM

Mount the distribution medium as above and copy the object module library to disk. For example, for a CD-ROM on drive DKA400:

$ MOUNT/MEDIA=CDROM/UNDEFINED_FAT=fixed:none:8192 DKA400:  FLDVV20DA 
$ BACKUP DKA400:[000000]LIBRARY.BCK/SAVE_SET  SYS$COMMON:[SYSLIB]
$ DISMOUNT DKA400:

Set the protection on the object module library file

$ SET PROTECTION=W:RE SYS$COMMON:[SYSLIB]NAG$LIBRARY.OLB

NAG$LIBRARY.OLB may be searched automatically by associating a logical name to the library file in the following fashion:
```
$ DEFINE/JOB LNK$LIBRARY SYS$COMMON:[SYSLIB]NAG$LIBRARY.OLB
```
If the logical name LNK$LIBRARY is already in use then the first empty logical name from the following list should be used:
```
LNK$LIBRARY_1, LNK$LIBRARY_2, ....., LNK$LIBRARY_n
```
If the user has sufficient privileges, the JOB qualifier may be replaced by the GROUP or the SYSTEM qualifiers. N.B. The association should be placed in the appropriate initialising command file, for example SYLOGICALS.COM for the /SYSTEM qualifier or the LOGIN.COM of authorised users. This will ensure that the library will still be linked automatically even if the system has to be re-booted.
Alternatively you can set the library up as you wish, for example by linking explicitly with the library in each LINK command.

4.1.3. Shareable Library Installation, without using INSTALL.COM

Mount the distribution medium as above and copy the object module library and the contents of INSTALL.BCK to disk. For example, for a CD-ROM on drive DKA400:

$ MOUNT/MEDIA=CDROM/UNDEFINED_FAT=fixed:none:8192 DKA400:  FLDVV20DA 
$ BACKUP DKA400:[000000]INSTALL.BCK/SAVE_SET  []
$ BACKUP DKA400:[000000]LIBRARY.BCK/SAVE_SET  []
$ DISMOUNT DKA400:

Convert the object module library to a shareable library
```
$ @NAGSHARE
```
and then copy the files required to use the shareable library to an appropriate directory, e.g.
```
$ COPY NAG$SHARE.OLB SYS$COMMON:[SYSLIB]NAG$SHARE.OLB
$ COPY NAG$SHARE.EXE SYS$COMMON:[SYSLIB]NAG$SHARE.EXE
```
The supplied file NAG$SHARE.MAR should be in the current directory when this procedure is used, if compatibility with previous shared versions and compatibility between sites is to be assured. After building the shared version for the first time, the resulting NAG$SHARE.MAR should be kept and the newest version used for each subsequent rebuild.
Set the protection on the shareable library files, e.g.
```
$ SET PROTECTION=W:RE SYS$COMMON:[SYSLIB]NAG$*.*
```
When linking the shareable library, NAG$SHARE.EXE must be associated with the logical name NAG$SHARE, unless it is placed in SYS$SHARE:NAG$SHARE.EXE, in which case no logical name association is needed. The association with the logical name NAG$SHARE may be achieved in the following fashion:
```
$ DEFINE/JOB NAG$SHARE SYS$COMMON:[SYSLIB]NAG$SHARE.EXE
```
The library file NAG$SHARE.OLB should be associated with a LNK$LIBRARY name:
```
$ DEFINE/JOB LNK$LIBRARY SYS$COMMON:[SYSLIB]NAG$SHARE.OLB
```
The library can have a higher LNK$LIBRARY name if required. If the user has sufficient privileges, the JOB qualifier may be replaced by the GROUP or the SYSTEM qualifiers. N.B. These associations should be placed in the appropriate initialising command file, for example SYLOGICALS.COM for the /SYSTEM qualifier or the LOGIN.COM of authorised users. This will ensure that the library will still be linked automatically even if the system has to be re-booted.

The example programs for the undocumented routines F06PBF, F06SBF, F06YCF and F06ZCF cannot be linked using the Shareable Library as a different version of the error handler is used in these tests. This does not affect the efficacy of these routines in normal usage.

4.2. Release to Users

The Users' Note (UN.HTML and UN.DOC) should be checked and amended as necessary (particularly Section 3.1). 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, D01AUF, G05LFF and X03AAF. 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:

ESSINT.DOC             from the save set DOC.BCK
NEWS.DOC               from the save set DOC.BCK
CONTENTS.DOC           from the save set DOC.BCK
WITHDRAWN.DOC          from the save set DOC.BCK
REPLACED.DOC           from the save set DOC.BCK
BLAS_LAPACK_TO_NAG.DOC from the save set DOC.BCK
NAG_TO_BLAS_LAPACK.DOC from the save set DOC.BCK
UN.HTML and UN.DOC     from the save set DOC.BCK

compiled library:

NAG$LIBRARY.OLB from the save set LIBRARY.BCK
(or the shareable library created from it)

example program material:

*.FOR from the save set EXPT.BCK
*.DAT from the save set EXPD.BCK
*.RES from the save set EXPR.BCK

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.3.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.3. Further Information

4.3.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.3.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.3.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 websites or contact your local NAG Response Centre for current prices (see Section 6).

A full on-line version of the NAG Fortran Library Manual is available in the form of Portable Document Format (PDF) files. Please contact NAG if you are interested in this.

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

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