NAG SMP Library, Mark 21

FSSOL21DCL - License Managed

Sun UltraSPARC-III 32 bit, Solaris, Sun Fortran, 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 SMP Library. It is available together with the Users' Note (un.html) on the distribution medium.

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

hardware:          Sun UltraSPARC-III systems and compatible
operating system:  SunOS 5.8 (Solaris 8) and compatible
Fortran compiler:  Sun Studio 9 Fortran 95 8.0 and compatible
Vendor library:    Sun Performance Library (Sunperf) 5 and compatible

2.2. Derivation

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

hardware:          sun4u sparc SUNW,Sun-Fire-880
operating system:  SunOS 5.8 (Solaris 8)
Fortran compiler:  Sun Studio 9 Fortran 95 8.0 2004/07/15
Vendor library:    Sun Performance Library (Sunperf) 5
Compiler options:  -fast -O4 -fsimple=1 -xvector=no -ftrap=%none \
-xtarget=ultra3cu -xarch=v8plusb -dalign -stackvar -KPIC \
-openmp -vpara

All source files were compiled with optimization flags -fast -O4 -openmp -vpara.

In this implementation calls to BLAS and LAPACK routines are implemented by calls to Sun Performance Library (Sunperf), except for the routines reported in Users' Note, Routine-specific Information. The library has been tested with Sunperf 5.

3. Distribution Medium

The software is ordinarily distributed in tar format on CD-ROM, it can also be downloaded from any of the NAG Web sites (see NAG Websites).

3.1. Contents

The following shows the directory/file organization of the implementation materials as they will be installed.
            |- doc -|- in.html  (Installer's Note, (this document))
            |       |- un.html  (Users' Note)
            |
            |       |- libnagsmp.a  (static library requiring
            |- lib -|                vendor BLAS/LAPACK)
            |       |- libnagsmp.so (shareable library requiring
            |                        vendor BLAS/LAPACK)
fssol21dcl -|
            |- nag_interface_blocks -|- *
            |
            |            |- source --|- ??????e.f
            |- examples -|- data ----|- ??????e.d
            |            |- results -|- ??????e.r
            |
            |- scripts -|- nagsmp_example*
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

The following shows the directory/file organization of the NAG Mark 21 Library Manual, which we will refer to as the Library Manual, as they will be installed.

nagdoc_mk21 -|- examples -|- baseresults -|- ??????*.r
             |            |- source      -|- ??????*.f
             |            |- data        -|- ??????*.d
             |
             |
             |- html -|- mark21.html                (main HTML index)
             |        |
             |        |- [A00-X05] -|- *conts.html  (chapter contents)
             |        |
             |        |- frontmatter -|- *.html     (foreword & copyright)
             |        |
             |        |- genint -|- *.html  (general introductory material
             |        |                      and online help document)
             |        |
             |        |- indexes -|- gams -|- fl_gams.html  (GAMS index)
             |        |           |        |- *.html        (GAMS files)
             |        |           |
             |        |           |- kwic -|- fl_kwic.html  (KWIC index)
             |        |                    |- *.html        (KWIC files)
             |        |
             |        |- styles -|- libdoc.css      (main CSS stylesheet)
             |
             |- pdf -|- frontmatter -|- mark21.pdf  (NAG copyright and main
                     |               |               pdf page)
                     |               |- foreword.pdf
                     |
                     |- [A00-X05] -|- *conts.pdf    (chapter contents)
                     |             |- *intro.pdf    (chapter introduction)
                     |             |- *f.pdf        (routine documents)
                     |
                     |- genint -|- *.pdf  (general introductory material
                     |                     and online help document)
                     |
                     |- indexes -|- *.pdf (bookmarked file containing links
                     |                     to fl_kwic.html and fl_gams.html)
                     |
                     |- INUNs -|- *.pdf   (implementation specific note)

3.2. File Sizes

The files require approximately the following disk space:
compiled libraries:
  libnagsmp.a                           30 MB
  libnagsmp.so                          23 MB
interface blocks:                        1 MB
example program material:                6 MB
scripts:                                 7 KB
implementation specific documentation:  24 KB
Library Manual:                        213 MB
licensing materials:                     2 MB

4. Installation

4.1. Installation of Library Software and Manual

This section provides two ways of installing the software, manual and other material provided.

4.1.1. Installation using install script

You can install the materials from the CD or download directory by executing the Bourne Shell script install in a command window as:
./install.sh
By default, the materials will be installed in /opt/NAG/ or /usr/local/NAG/ depending on your system. The installer may choose a different location. In this document we refer to the directory /opt/NAG/fssol21dcl or /usr/local/NAG/fssol21dcl as [INSTALL_DIR].

The directory [INSTALL_DIR] is referenced in the Users' Note (un.html).

The directory [INSTALL_DIR]/scripts contains one or more scripts to show how to use the libraries provided with this implementation. See Users' Note, Example Programs. Subsequent to the installation, if the installer moves the library to some other location then these scripts must be changed to reflect that fact.

To simplify access to the libraries you may wish to create symbolic links in a system location such as /usr/lib pointing at the installed libraries. They would then be in the default search path of the linker during the link phase, and be available for execution at run time (in the case of shareable libraries). Note that if both the static and shareable version of a library are placed in a directory then the shareable version is usually used by default.

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

The interface block files (nag_interface_blocks/*) are supplied in both source form and pre-compiled module form.

The -Mpathname option should then be specified on each f90/f95 invocation (where pathname is [INSTALL_DIR]/nag_interface_blocks) to tell the compiler where to find the modules.

The install script can install the Library Manual in the same location as the NAG Library material or at some other location of the installer's choice.

You may wish to move the Library Manual to the same location as that for other NAG products. You are encouraged to make them readily available to users.

4.1.2. Installation without using install script

The libraries can be installed manually by following the instructions below:

Use the tar utility to extract the materials, e.g.

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

Each library is provided in both static and shareable format. You may choose to install some or all of the libraries.

To simplify access to the libraries you may wish to create symbolic links in a system location such as /usr/lib pointing at the installed libraries. Then they would be in the default search path of the linker during the link phase, and be available for execution at run time (in the case of shareable libraries). Note that if both the static and shareable version of a library are placed in a directory then the shareable version is usually used by default.

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

The interface block files (nag_interface_blocks/*) are supplied in both source form and pre-compiled module form.

The -Mpathname option should then be specified on each f90/f95 invocation (where pathname is [INSTALL_DIR]/nag_interface_blocks) to tell the compiler where to find the modules.

The directory [INSTALL_DIR]/scripts contains one or more scripts to show how to use the libraries provided with this implementation. These scripts refer to the local directory containing the example programs. The files should be copied to (for example) /usr/local/bin, modified to reflect the local installation, and their protection set to world execute.

To install the Library Manual, use the tar utility, e.g.

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

You may wish to move the Library Manual to the same location as that for other NAG products. You are encouraged to make them readily available to users.

4.1.3. License Management

The use of the NAG SMP Library is controlled by the Kusari license management system. This release of the NAG SMP Library uses version 2.1 of Kusari.

In order to enable the software, NAG will issue you with a license key. The license key is contained in a text file consisting of details of the software that will be enabled.

To request a license key, run the program khostid located in the license/bin/sparc/ subdirectory of the software distribution. This utility must be run from a command prompt. Return the information that it displays, together with the product code (in this case FSSOL21DC), by e-mail (or FAX) to NAG. Alternatively, direct the output from this utility to a file and send both the file and the product code to NAG.

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

FSSOL21DC TRIAL 2006/06/12 "EMnxidA3oeoj0F1Yvi5ibxPjB7"
Specifically, it has a line containing the word TRIAL. Longer term 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 word NODE instead of the word TRIAL above.

Once you have obtained one of the above license keys, store the text of it in a file, say

 [INSTALL_DIR]/license.lic.
The location of the license file must be made known to the NAG application by setting the environment variable NAG_KUSARI_FILE to the full pathname of the file before the application is invoked.

For example, in the C-shell, type:

   setenv NAG_KUSARI_FILE [INSTALL_DIR]/license.lic
or in the Bourne shell, type:
   NAG_KUSARI_FILE=[INSTALL_DIR]/license.lic
   export NAG_KUSARI_FILE

Further details about Kusari and how it may be configured to suit your local circumstances are included in the Kusari License Management documentation in the license/doc/ subdirectory of the software distribution.

4.2. Release to Users

The Users' Note (doc/un.html) should be checked and amended as necessary (particularly Sections 3.1, 3.2 and 5). Advice on accessing the library (see Users' Note, Section 3.1) can be checked by running a few example programs following that advice; a suitable sample would be D01AUF, E04UCA and F07ADF. The installation can also be tested using the scripts nagsmp_example*. (see Users' Note, Section 3.2). The Users' Note (doc/un.html) 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_mk21 directory contains the Library Manual. This should be made available to users.

compiled libraries:

  libnagsmp.a
  libnagsmp.so
interface block files:
  nag_interface_blocks/*
example program material:
  examples/source/??????e.f
  examples/data/??????e.d
  examples/results/??????e.r
  scripts/nagsmp_example*

Note that the example material has been adapted, if necessary, from that published in the Library Manual, so that programs are suitable for execution with this implementation with no further changes (but see Section 4.3.1 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. Example Programs

The example results distributed were generated at Mark 21, 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, 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 installer should ensure that the advice given to users in Section 3.1 of the Users' Note (un.html) is suitable for the installation. This can be done by running a few example programs following that advice. The installation can also be tested using the scripts nagsmp_example*.

4.3.2. Maintenance Level

The maintenance level of the Library can be determined by compiling and executing the example that calls A00AAF, or you could call the script nagsmp_example with the arguments a00aaf 1. See Users' Note, Example Programs . This example prints out details of the implementation, including title and product code, compiler and precision used, mark and maintenance level.

5. Documentation

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

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

(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 the following URLs:

http://www.nag.co.uk/, http://www.nag.com/ or http://www.nag-j.co.jp/

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

(e) Product Registration

To ensure that you receive information on updates and other relevant announcements, please register this product with us. For NAG Library products this may be accomplished by filling in the online registration form at http://www.nag.co.uk/numeric/Library_Registration.asp.

7. User Feedback

Many factors influence the way that 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 any of the NAG Response Centres (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: support@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2337
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