NAG C Library, Mark 9

CLL6A09DHL - License Managed

Linux x86_64, gcc, 64-bit integers

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. 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 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.26.8-57 (glibc-2.7-2) and compatible
C compiler:        GCC version 4.1.2 and compatible

2.2. Derivation

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

hardware:         Intel Xeon E5310 1.60GHz
operating system: Linux 2.6.25.10-47.fc8 (Fedora release 8 (Werewolf))
                  with glibc-2.7-2
C compiler:       GCC version 4.1.2
                  Compiler Options: -m64 -fPIC -fexceptions

This implementation was also tested on the AMD system described below:

hardware:         AMD Athlon 64 3400+
operating system: Linux 2.6.31-14-server (Ubuntu 9.10 (Karmic Koala))
                  with glibc-2.10-1
C compiler:       GCC version 4.4.1

The NAG C Library, Mark 09, was compiled with the highest level of optimization that enabled the functionality provided by the library to be verified and validated (-O3).

This library has been tested using the Basic Linear Algebra Subprograms (BLAS) and Linear Algebra PACKage (LAPACK) routines provided by NAG (see the Chapter Introductions for f07, f08 and f16 in the NAG Mark 09 Library Manual, which we will refer to as the Library Manual).

The library has also been tested with version 4.3.1 of the AMD Core Math Library for Linux (ACML) which is supplied as a part of this product (see contents).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/cl09/l6adhl/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 or DVD as appropriate.

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

libnagc_acml.a and libnagc_acml.so do not contain the NAG versions of the BLAS and LAPACK routines, apart from ztgsen, dtrsm and zcgesv which were found to cause problems during testing.

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

nagdoc_cl09 -|- index.html
             |
             |- examples -|- baseresults -|- *.r
             |            |- source      -|- *.c
             |            |- data        -|- *.d, *.opt
             |
             |- html  -|- FRONTMATTER -|- manconts.html  (main HTML index)
             |         |               |- *.html         (foreword & copyright)
             |         |
             |         |- [A00-X04] -|- *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-X04] -|- *conts.pdf    (chapter contents)
             |         |             |- *intro.pdf    (chapter introduction)
             |         |             |- *c.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-X04] -|- *conts.xml  (chapter contents)
                       |             |- *intro.xml  (chapter introduction)
                       |             |- *c.xml      (routine documents)
                       |
                       |- 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:  266 MB
  Library Manual:    242 MB

4. Installation

4.1. Installation of Library Software and Manual

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

gunzip cll6a09dhl.tgz
tar xvf cll6a09dhl.tar
This will extract the files install.sh, cl09.tar, lic_agr.txt, in.html and un.html, and the directory licence.

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

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

4.1.1. Installation

You can install the materials from the CD/DVD or download directory by executing the Bourne Shell script install in a command window as:
./install.sh
If you are logged in as root then by default, the materials will be installed in /opt/NAG/ or /usr/local/NAG/ depending on your system. However, you may choose a different location. In this document we refer to the directory /opt/NAG/cll6a09dhl or /usr/local/NAG/cll6a09dhl 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, Section 3.2. 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 include files should 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 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. License Management

The use of the NAG C Library is controlled by the Kusari license management system. This release of the NAG C 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 appropriate subdirectory of the software distribution for your platform (eg license/bin/amd64/). This utility must be run from a command prompt. Return the information that it displays, together with the product code (in this case CLL6A09DHL), 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:

CLL6A09DH TRIAL 2009/11/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 (e.g. how to install the license key on a server) are included in the Kusari License Management documentation in the license/doc/ subdirectory of the software distribution. See also the Kusari FAQ: http://www.nag.co.uk/Kusari/kusari_faq.html.

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 d01sjc, f07adc and g05sjc. The installation can also be tested using the scripts nagc_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_cl09 directory contains the Library Manual.

compiled libraries:

  libnagc_nag.a
  libnagc_nag.so (symbolic link pointing at libnagc_nag.so.9)
  libnagc_acml.a
  libnagc_acml.so (symbolic link pointing at libnagc_acml.so.9)
  ACML libraries supplied by NAG
include files:
include/*.h
example program material:
  examples/source/??????e.c
  examples/data/??????e.d
  examples/data/??????e.opt
  examples/results/??????e.r
  scripts/nagc_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.2 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 a00aac, or you could call one of the nagc_example scripts with the argument a00aac. See Users' Note, Section 3.2 . 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 or account no. and NAG product code (in this case CLL6A09DHL).

(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