NAG C Library, Mark 8

CLL6A08DGL - License Managed

Linux (x86-64), GNU gcc

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 C 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 C Library that is considered suitable for operation on the computer systems detailed below:

hardware:          AMD 64-bit systems and compatible (including EM64T)
operating system:  Linux 2.6.11.4-20a (SuSE 9.3 x86-64) and compatible
C compiler:        gcc 3.3.5 and compatible (including Intel icc 8.1)
Vendor Library:    AMD ACML version 3.0.0 and compatible

2.2. Derivation

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

hardware:          AMD Athlon 64
operating system:  Linux 2.6.11.4-20a (SuSE 9.3 x86-64)
C compiler:        gcc 3.3.5 and compatible

This implementation has also been tested on the Intel Extended Memory 64 Technology system detailed below:

hardware:          EM64T
operating system:  Linux 2.6.5-1.358 (Fedora Core release 2 (Tettnang))
                   with glibc 2.3.3-27
C compiler:        GNU C compiler gcc Version 3.3.3

The entire NAG C Library, Mark 8, was compiled with compiler optimization -O3.

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 C Library Manual).

The library has been also tested with AMD ACML version 3.0.0. The AMD ACML libraries are being supplied as a part of this product (see contents). To use this version of the ACML, the g77 runtime libraries (libg2c.a/libg2c.so) provided with this distribution must also be installed.

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)
            |
            |       |- libnagc_nag.a    (static self-contained library
            |       |                    including NAG BLAS/LAPACK)
            |       |- libnagc_nag.so.8 (shareable self-contained library
            |       |                    including NAG BLAS/LAPACK)
            |       |- libnagc_nag.so   (symbolic link pointing at
            |- lib -|                    libnagc_nag.so.8)
            |       |- libnagc_acml.a   (static library requiring
            |       |                    AMD ACML BLAS/LAPACK)
            |       |- libnagc_acml.so.8 (shareable library requiring
            |       |                     AMD ACML BLAS/LAPACK)
            |       |- libnagc_acml.so  (symbolic link pointing at
cll6a08dgl -|                            libnagc_acml.so.8)
            |- include -|- *.h
            |
            |            |- source --|- ??????e.c
            |- examples -|- data ----|- ??????e.d
            |            |- results -|- ??????e.r
            |
            |- scripts -|- nagc_example*
            |
            |- acml_64 -|- * (AMD Core Math Library)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

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

nagdoc_cl08 -|- examples -|- replaced    -|- *.c
             |            |- baseresults -|- *.r
             |            |- source      -|- *.c
             |            |- data        -|- *.d
             |
             |- html  -|- mark8.html                (main HTML index)
             |         |
             |         |- [A00-X04] -|- *conts.html (chapter contents)
             |         |
             |         |- genint  -|- cl_*.html (general introductory material
             |         |                         and online help document)
             |         |
             |         |- indexes -|- gams -|- cl_gams.html (GAMS index)
             |         |           |        |- cl*.html     (GAMS files)
             |         |           |
             |         |           |- kwic -|- cl_kwic.html (KWIC index)
             |         |                    |- cl*.html     (KWIC files)
             |         |
             |         |- styles  -|- libdoc.css   (main CSS stylesheet)
             |
             |- pdf   -|- frontmatter -|- mark8.pdf  (NAG copyright and main
             |         |                              pdf page)
             |         |
             |         |- [A00-X04] -|- *conts.pdf (chapter contents)
             |         |             |- *intro.pdf (chapter introduction)
             |         |             |- *c.pdf     (routine documents)
             |         |
             |         |- genint  -|- *.pdf   (general introductory material
             |         |                       and online help document)
             |         |
             |         |- indexes -|- *.pdf   (bookmarked file containing links
             |         |                       to cl_kwic.html and cl_gams.html)
             |         |
             |         |- INUNs   -|- *.pdf   (implementation specific note)
             |
             |- xhtml -|- mark8.xml   (main XHTML index)
                       |
                       |- [A00-X04] -|- *conts.xml   (chapter contents)
                       |             |- *intro.xml   (chapter introduction)
                       |             |- *c.xml       (routine documents)
                       |
                       |- genint  -|- cl_*.xml (general introductory material 
                       |                        and online help document)
                       |
                       |- indexes -|- gams -|- cl_gams.xml (GAMS index)
                       |           |        |- cl*.xml     (GAMS files)
                       |           |
                       |           |- kwic -|- cl_kwic.xml (KWIC index)
                       |           |        |- cl*.xml     (KWIC files)
                       |
                       |- figures -|- *.png   (images used in documentation)
                       |
                       |- styles  -|- libdoc.css   (main CSS stylesheet)
                                   |- *mathml*.xsl (mathml XSLT templates)

3.2. File Sizes

The files require approximately the following disk space:
compiled libraries:
  libnagc_nag.a      28 Mb
  libnagc_nag.so.8   15 Mb

  libnagc_acml.a     27 Mb
  libnagc_acml.so.8  15 Mb


include files:      840 Kb


ACML libraries    :  31 Mb

example program material:       11 Mb
scripts:                        20 Kb
library documentation files:    48 Kb
manual documentation files:    179 Mb
licensing materials            1.6 Mb

4. Installation

4.1. Library and Documentation Installation

This section provides two ways of installing the libraries, documentation and other material provided. In future the manual installation section may be removed.

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. However, the installer may choose a different location. In this document we refer to the directory /opt/NAG/cll6a08dgl or /usr/local/NAG/cll6a08dgl 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 move the symbolic links to 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 install script can install the Library documentation material 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 documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users.

The include files may be moved to a directory such as /usr/include so that they can be accessed during compilation, e.g.

mv include/*.h /usr/include

4.1.2. Manual Installation

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

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

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

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 ACML supplied BLAS and LAPACK. You may choose to install some or all of the libraries.

To simplify access to the libraries you may wish to move the symbolic links to 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.

To install the Library documentation material manually, use the tar utility, e.g.

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

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

The include files may be moved to a directory such as /usr/include so that they can be accessed during compilation, e.g.

mv include/*.h /usr/include

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.

4.1.3. License Management

The use of the NAG C Library is controlled by the Kusari network license management system. This release of the NAG C 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 a simple text file containing details of the software that will be enabled.

To request a license key, run the program khostid located in the license/bin/amd64/ subdirectory of the software distribution. This utility must be run from a command prompt. Return the information that it displays by e-mail (or FAX) to NAG.

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

CLL6A08DGL TRIAL 2006/02/12 "EMnxidA3oeoj0F1Yvi5ibxPjB7"
Specifically, it has a line containing the word TRIAL and is referred to here as an uncounted license key. Longer term uncounted 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. Other types of keys may also be issued.

Once you have obtained the license key, store the text of it in a file, say [INSTALL_DIR]/license.lic.

For an uncounted license, 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
No other actions are required to install an uncounted license.

Further details about Kusari and how it may be configured to suit your local circumstances are included in the Kusari Licence 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 in Section 3.1 can be checked by running a few example programs following that advice; a suitable sample would be d01ajc, g05lfc and f07adc. The installation can also be tested using the scripts nagc_example*. 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_cl08 directory contains the online documentation. This should be made available to users, in addition to the following:

compiled libraries:

  libnagc_nag.a
  libnagc_nag.so (symbolic link to libnagc_nag.so.8)
  libnagc_acml.a
  libnagc_acml.so (symbolic link to libnagc_acml.so.8)
  AMD ACML libraries supplied by NAG
Include files:
include/*.h
example program material:
  examples/source/??????e.c
  examples/data/??????e.d
  examples/results/??????e.r
  scripts/nagc_example*

Note that the example material has been adapted, if necessary, from that published in the NAG C 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

For best performance we recommend that you should use the variant of the NAG C Library which is based on the supplied ACML library i.e. libnagc_acml.a or libnagc_acml.so. However if you use a version of the ACML library different from the version used in creating this implementation and you have problems when calling a NAG routine, we suggest that you use the self-contained libraries libnagc_nag.a or libnagc_nag.so.

4.3.1. Example Programs

The example results distributed were generated at Mark 8, 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 C 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.

4.3.2. Maintenance Level

The maintenance level of the library can be determined by compiling and executing the example that calls a00aac or you could call the script nagc_example with the argument a00aac. 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. See Section 3.1 for the location of the online help files in HTML, PDF and XHTML formats.

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

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