NAG Fortran Library, Mark 22

FLSO622DCL - License Managed

Sun UltraSPARC 64 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 Fortran 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. Requests for information about the availability of other implementations must be referred to NAG.

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:          Sparc Ultra systems
operating system:  SunOS 5.10 (Solaris 10) and compatible 
Fortran compiler:  Sun Studio 11 (Fortran 95 8.2) and compatible
                   (including Sun Studio 12)

2.2. Derivation

This implementation was produced at NAG Ltd., Oxford on the computing system detailed below:
hardware:          SUN Enterprise 420R (Ultra SPARC II CPU)
operating system:  SunOS 5.10 Generic sun4u sparc SUNW,Ultra-80
                   (Solaris 10)
Fortran compiler:  Sun Studio 11 (Sun Fortran 95 8.2 2005/10/13)
compiler switches: -w -xtarget=ultra3cu -xarch=v9a -stackvar -mt -KPIC
                   -O4 -fsimple=1 -depend -dalign -xprefetch=yes
and was also tested on the above hardware using Sun Studio 12:
hardware:          as above
operating system:  as above
Fortran compiler:  Sun Studio 12
                   (Sun Fortran 95 8.3 SunOS_sparc Patch 127000-01 2007/07/18)
Please note that some compiler switches have been deprecated at Sun Studio 12. To avoid warning messages the compiler switch -xarch=v9a need to be replaced by -m64 -xarch=sparcvis.

The NAG Fortran Library, Mark 22, was compiled with the highest level of optimization that enabled the functionality provided by the library to be verified and validated.

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 Mark 22 Library Manual, which we will refer to as the Library Manual).

The library has also been tested with the Sun Performance Library (SPL) BLAS and LAPACK routines.

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/fl22/so6dcl/postrelease.html

for details of any new information related to the applicability or usage of this implementation.

3. Distribution Medium

The software is available to download from any of the NAG Web sites (see NAG Websites). Upon request, the software may be distributed by CD-ROM.

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)
            |
            |       |- libnag_nag.a  (static self-contained library
            |       |                 including NAG BLAS/LAPACK)
            |- lib -|- libnag_nag.so (shareable self-contained library
            |       |                 including NAG BLAS/LAPACK)
            |       |- libnag_spl.a  (static library requiring
            |       |                 vendor BLAS/LAPACK "SPL")
            |       |- libnag_spl.so (shareable library requiring
            |                         vendor BLAS/LAPACK "SPL")
flso622dcl -|
            |- nag_interface_blocks -|- *
            |
            |            |- source --|- ??????e.f
            |- examples -|- data ----|- ??????e.d
            |            |- results -|- ??????e.r
            |
            |- scripts -|- nag_example*
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

libnag_spl.a and libnag_spl.so do not contain the NAG version of Basic Linear Algebra Subprograms (BLAS) nor the linear algebra functions (LAPACK).

The following shows the directory/file organization of the Library Manual materials as they will be installed.

nagdoc_fl22 -|- examples -|- baseresults -|- ??????*.r
             |            |- source      -|- ??????*.f
             |            |- data        -|- ??????*.d
             |
             |- html  -|- FRONTMATTER -|- manconts.html  (main HTML index)
             |         |               |- *.html         (foreword & copyright)
             |         |
             |         |- [A00-X05] -|- *conts.html  (chapter contents)
             |         |
             |         |- GENINT -|- *.html  (general introductory material)
             |         |
             |         |- INDEXES -|- GAMS -|- gams.html  (GAMS index)
             |         |           |        |- *.html     (GAMS files)
             |         |           |
             |         |           |- KWIC -|- kwic.html  (KWIC index)
             |         |                    |- *.html     (KWIC files)
             |         |
             |         |- styles -|- libdoc.css  (main CSS stylesheet)
             |
             |- pdf   -|- FRONTMATTER -|- manconts.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)
             |         |
             |         |- INDEXES -|- *.pdf (bookmarked file containing links
             |         |                     to kwic.xml and gams.xml)
             |         |
             |         |- INUNs -|- usersnote.pdf   (implementation specific note)
             |
             |- xhtml -|- FRONTMATTER -|- manconts.xml  (main XHTML index)
                       |               |- *.xml         (foreword & copyright)
                       |
                       |- [A00-X05] -|- *conts.xml  (chapter contents)
                       |
                       |- figures -|- *.png  (figures and plotfiles)
                       |
                       |- GENINT -|- *.xml  (general introductory material)
                       |
                       |- INDEXES -|- GAMS -|- gams.xml  (GAMS index)
                       |           |        |- *.xml     (GAMS files)
                       |           |
                       |           |- KWIC -|- kwic.xml  (KWIC index)
                       |                    |- *.xml     (KWIC files)
                       |
                       |- styles -|- libdoc.css      (main CSS stylesheet)

3.2. File Sizes

The files require approximately the following disk space:
  Library software:  145.4 MB
  Library Manual:    295.5 MB

4. Installation

4.1. Installation of Library Software and Manual

This section provides two ways of installing the software and manual.

If you have downloaded the Library materials from our web site as a tar gzip file (flso622dcl.tgz), cd to the directory where the file is located and extract the installation materials using the following commands:

gunzip flso622dcl.tgz
tar xvf flso622dcl.tar
This will extract the files install.sh, fl22.tar, in.html and un.html.

If you have downloaded the Library Manual as a tar gzip file (mk22_doc.tgz) run the command

gunzip mk22_doc.tgz
to extract the file mk22_doc.tar.

Then follow one of the sets of instructions below to complete the installation.

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. You may choose a different location. In this document we refer to the directory /opt/NAG/flso622dcl or /usr/local/NAG/flso622dcl as [INSTALL_DIR]. This convention is also used 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 you move the library to some other location then these scripts must be changed to reflect that fact.

Each library is provided in both static and shareable format. You also have a choice of libraries; self contained libraries which use NAG supplied BLAS and LAPACK or libraries which require the use of vendor supplied BLAS and LAPACK.

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 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 programs. Their purpose is to allow the Fortran compiler to check that NAG Fortran Library routines are called correctly.

The interface block files (nag_interface_blocks/*) are supplied in both source form and pre-compiled module form. (The source form is only required if the pre-compiled form is incompatible with the compiler in use.)

The -Mpathname option should then be specified on each compiler invocation (where pathname is [INSTALL_DIR]/nag_interface_blocks) to tell the compiler where to find the modules (see Users' Note, Interface Blocks).

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

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

4.1.2. Installation without using install script

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

Move to the directory where you wish to install the product and use the tar utility to extract the materials, e.g.

tar xvf /cdrom/fl22.tar
if you are installing from a CD and the CD-ROM has been mounted as /cdrom, or
tar xvf /full path to download directory/fl22.tar
if you downloaded the product from our web site.

Each library is provided in both static and shareable format. You also have a choice of libraries; self contained libraries which use NAG supplied BLAS and LAPACK or libraries which require the use of vendor supplied BLAS and LAPACK.

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 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 programs. Their purpose is to allow the Fortran compiler to check that NAG Fortran Library routines are called correctly.

The interface block files (nag_interface_blocks/*) are supplied in both source form and pre-compiled module form. (The source form is only required if the pre-compiled form is incompatible with the compiler in use.)

The -Mpathname option should then be specified on each compiler invocation (where pathname is [INSTALL_DIR]/nag_interface_blocks) to tell the compiler where to find the modules (see Users' Note, Interface Blocks).

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, move to the directory where you wish to install it and use the tar utility, e.g.

tar xvf /cdrom/mk22_doc.tar
if you are installing from a CD and the CD-ROM has been mounted as /cdrom, or
tar xvf /full path to download directory/mk22_doc.tar
if you downloaded the installation from our web site.

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

4.1.3. License Management

The use of the NAG Fortran Library is controlled by the Kusari license management system. This release of the NAG Fortran Library uses version 2.2 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/sparc64/ 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 FLSO622DCL), 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:

FLSO622DC TRIAL 2009/08/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.3 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 nag_example* (see Users' Note, Section 3.3). 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_fl22 directory contains the Library Manual. This should be made available to users.

compiled libraries:

  libnag_nag.a
  libnag_nag.so
  libnag_spl.a
  libnag_spl.so
interface block files:
  nag_interface_blocks/*
example program material:
  examples/source/??????e.f
  examples/data/??????e.d
  examples/results/??????e.r
  scripts/nag_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 3.3 of the Users' Note 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. Maintenance Level

The maintenance level of the Library can be determined by compiling and executing the example that calls A00AAF, or you could call one of the nag_example scripts with the argument a00aaf. 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. Support from NAG

(a) Contact with NAG

Queries concerning this document or the implementation generally should be directed to NAG 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 FLSO622DCL).

(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 announcements about new products or product/service enhancements, technical tips, 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.

6. 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
801 Warrenville Road
Suite 185
Lisle, IL  60532-4332                   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