NAG Fortran Library, Mark 19

FLW3219DDL - License Managed

Windows 95/98/NT Compaq Visual Fortran, 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:         32-bit Intel systems and compatibles
operating system: Windows 95/98 or Windows NT
Fortran compiler: Compaq Visual Fortran version 6.0 and compatible

Although this implementation is a static library implementation, it can be called from Microsoft Visual C++ versions 5.x and 6.x (see Section 3.7 of the Users' Note). To interface with Microsoft Visual Basic, Excel and other Windows software, the NAG DLL implementation is more appropriate.

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:         Dell OptiPlex GX1
operating system: Windows NT 4.0
Fortran compiler: Compaq Visual Fortran version 6.1
compiler options: /compile /nodebug /bintext:"NAG Copyright 2000"
utilities:        Intel MKL library, version 3.2

The entire NAG Fortran Library, Mark 19, was compiled with full optimization (/optimize:5), except for the following routines which had to be compiled at lesser optimization levels:

E02AHZT.FOR (/optimize:4)    E04GZFT.FOR (/optimize:0)

This library has been tested using the Basic Linear Algebra Subprograms (BLAS) provided in the Intel MKL Library, version 3.2 and linear algebra routines (LAPACK) provided by NAG (see the Chapter Introductions for F06, F07 and F08 in the NAG Fortran Library on-line documentation (PDF files)).

3. Distribution Medium

3.1. Recording Details

The implementation is distributed 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
                      |-- essint
                      |-- summary
                      |-- news
            |-- doc --|-- replaced
            |         |-- calls
            |         |-- called
            |         |-- blas_lapack_to_nag
            |         |-- nag_to_blas_lapack
            |         |-- mk19.hlp
            |
            |             |-- nagmk19.h
            |             |-- nagmk19.hxx
            |-- headers --|-- techdoc.html
            |             |-- mk19 --|-- *.c
flw3219dd --|
            |-- naglib.lib
            |
            |-- interface_blocks --|-- *.mod
            |                      |-- source --|-- *.f90
            |
            |              |-- source ---|-- *.for
            |-- examples --|-- data -----|-- *.dat
            |              |-- results --|-- *.res
            |
            |-- batch --|-- nagex.bat

3.3. File Sizes

The files sizes are given below. The actual disk space used is dependent on the hard disk allocation unit (cluster) size (this information is supplied by the DOS command CHKDSK):
compiled library:          16.1 Mb
interface blocks:           2.8 Mb
example program material:   4.3 Mb
documentation files:        6.2 Mb
C and C++ header material:  0.9 Mb

4. Library Installation

4.1. Installation

The CD should autorun on Windows 95/98 and NT 4.0 systems, and will then lead you to a dialogue for installation.

If the autorun facility does not operate, then double click on the setup.exe file on the CD using Windows Explorer. Any continuing difficulties indicate a problem which should be reported to the NAG Response Centre (see Section 6).

The installation program will ask you for the drive and directory where you would like to install the library materials. You will also be asked which parts of the materials you want to install. The installation program may be used to install all the materials from CD-ROM or just some part of it, for example the library.

An uninstall facility is provided. This will remove the product from the user's disk. It will also undo the registry entries made during installation, but will not undo any changes to the autoexec.bat file. If a re-installation is performed, for example to add a component that wasn't originally installed, the uninstall facility will remove only the most recently added files. (However, it will still remove all the registry entries associated with this software.) The uninstaller will not remove files created since the installation was completed (although it will remove original files that have been modified), so the user may have to delete these files to complete the removal.

After installation you should ensure that the software described in Section 3.2 is present and accessible.

The NAG Fortran Library Interface Blocks define the type and arguments of each user callable NAG Fortran Library routine, using Fortran 90 constructs. Although they are not essential to calling the NAG Fortran Library from Fortran 90 programs, they will allow a Fortran 90 compiler (such as the Compaq Visual Fortran 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 made accessible to the user. If you are using a different version of the Compaq Visual Fortran compiler from that given in Section 2.1, it may be necessary to recompile the interface blocks before making them available.

The batch file nagex.bat requires the setting of the environment variable nagfldir. It should be set to the root directory of the NAG materials.

Under Windows 95/98, the autoexec.bat file can be edited to add the environment variable. If the default location is used, add the line

set nagfldir=c:\flw3219dd

This change to the autoexec.bat file can be made by the installation procedure if desired.

Under Windows NT, the environment variable value can be set in the Control Panel | System Properties dialog. If the default location is used, set the variable to

nagfldir
and the value to
c:\flw3219dd

The batch file should be made accessible to the user (for example, by copying the file to a directory in the user's path, e.g. c:\utils).

It is recommended that you add the library and module files paths to the LIB and INCLUDE environment variables respectively. This will simplify linking with the library and using the interface blocks on the command line (see Sections 3.1 and 3.6 of the Users' Note). Under Windows 95/98, this requires a change to the autoexec.bat file which can be made by the installation procedure; under Windows NT, the environment variables can be set in the Control Panel | System Properties dialog.

If your machine has more than one processor, then it is recommended that you set the environment variable mkl_nprocs to the number of available processors, e.g.

set mkl_nprocs=2
This will enable the Intel MKL BLAS to make use of the extra processor(s) and will thus speed up the computation of many of the NAG library routines.

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.0c of FLEXlm. The remainder of this section describes how a FLEXlm license key should be installed to enable the use of the Library.

For the NAG Fortran Library you will be provided with an uncounted license key for use on a specific machine. This type of license is bound to a PC through the volume serial number of the PC's Windows drive (where the Windows directory is installed); this will normally be the C drive. To obtain the volume serial number, type "vol" in an MS-DOS window while accessing the appropriate drive.

To obtain the appropriate license key, contact the NAG Response Centre quoting the volume serial number of your machine and specify that you wish to obtain a PC license for the NAG Fortran Library. You will then receive your license information, usually by email or fax.

The information that you receive from NAG contains a FEATURE line describing the product being licensed. This line has to be inserted into a license file (say c:\flw3219dd\license.dat). The license file is a text file (usually created using a text editor, for example EDIT) and the FEATURE line must occupy a single record; none of the characters in the FEATURE line may be modified or the license will be invalid.

The format of the FEATURE line of a NAG Fortran Library license is as follows:

FEATURE NAG_FL NAG 19.000 01-jan-0000 0 2CE45AEB6D064ACEBE61 "W32D," \
        DISK_SERIAL_NUM=b0d85e5b

This enables the use of version 19.0 of the application NAG_FL with no time limit on the system with the specified volume serial number. Note that the line is continued by escaping the newline character with '\'.

To activate the license, the location of this file must be made known to the NAG Fortran Library. This is done by setting the environment variable LM_LICENSE_FILE to the full pathname of the license file. Using the license file described above as an example, under Windows 95/98 this can be done by adding the line

set LM_LICENSE_FILE=c:\flw3219dd\license.dat
to the autoexec.bat file and then rebooting the system.

Under Windows NT, LM_LICENSE_FILE can be added as a system or user environment variable using the Control Panel | System Properties dialog.

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 nagex.bat, which will copy an example program and its data, compile it, link it with the library and run it. To run an example program, create, for example, the directory c:\test. Make c:\test the current directory, copy the file nagex.bat to it and then give, for example, the command:

     
nagex c06eaf

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
doc\mk19.hlp
compiled library:
naglib.lib
interface block files:
interface_blocks\*.mod
example program material:
examples\source\*.for
examples\data\*.dat
examples\results\*.res
batch\nagex.bat
C header material:
headers\nagmk19.h
headers\nagmk19.hxx
headers\techdoc.html
headers\mk19\*.c 

Note that the example material has been adapted, if necessary, from that supplied in the on-line documentation, 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 on-line documentation. 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 on-line documentation. 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

A printed copy of the NAG Fortran Library Introductory Guide is normally provided with this implementation.

A full on-line version of the NAG Fortran Library Manual is provided in the form of Portable Document Format (PDF) files, and is included with this implementation on the distribution medium.

Abbreviated on-line documentation of the routines is also provided in Windows help file form as part of this implementation.

Printed copies of the NAG Fortran Library Manual 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.

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

(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

[NP3495/IN - License Managed]