NAG C Library, Mark 24

CLLUX24DCL - License Managed

Linux (x86-32), Intel C/C++

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:          x86-32 systems and compatible (including Intel, AMD)
operating system:  Linux 2.6.26.8-57 (glibc-2.7-2) and compatible
C compilers:       Intel C/C++ Compiler XE for applications running on IA-32
                   Version 14.0 and compatible
                   GCC version 4.1.2 and compatible

The definitions and sizes of the Integer and Pointer types used in this implementation are shown in Section 3.3 of the Users' Note.

2.2. Derivation

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

hardware:         Intel(R) Xeon(R) CPU 1.60GHz
operating system: Linux 2.6.26.8-57.fc8 (Fedora release 8 (Werewolf))
                  with glibc-2.7-2
C compiler:       Intel C/C++ Compiler XE for applications running on IA-32
                  Version 14.0.2.144
                  Build 20140120

This implementation was also tested on the Intel systems described below:

hardware:         Intel(R) Xeon(R) CPU 1.60GHz
operating system: Linux 2.6.26.8-57.fc8 (Fedora release 8 (Werewolf))
                  with glibc-2.7-2
C compiler:       gcc version 4.1.2

hardware:         Intel(R) Xeon(R) E5405 2.00GHz
operating system: Linux version 2.6.27.41-170.2.117.fc10.x86_64 Fedora
                  release 10 (Cambridge) with glibc-2.9-3
C compiler:       Intel C/C++ Compiler XE for applications running on IA-32
                  Version 13.1.3.192 (gcc version 4.3.2 compatibility)
and the following AMD system
hardware:         AMD Opteron(tm) Processor 6174 800.000 MHz
operating system: Linux version 2.6.34.7-0.7-desktop (openSUSE 11.3 (x86_64))
                  with glibc-2.11.2-3
C compiler:       Intel C/C++ Compiler XE for applications running on IA-32
                  Version 13.1.3.192 (gcc version 4.5.0 compatibility)

The NAG C Library, Mark 24, 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 PACKage (LAPACK) routines provided by NAG (see the Chapter Introductions for f07, f08 and f16 in the NAG Mark 24 Library Manual, which we will refer to as the Library Manual).

The library has also been tested with version 11.1.1 of the Intel ® Math Kernel Library for Linux (MKL) which is supplied as a part of this product (see Section 3.1). Please see the Intel website for further information about MKL (https://software.intel.com/intel-mkl).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/cl24/luxdcl/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 websites (see NAG Websites under Section 5). 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.24 (shareable self-contained library
            |       |                    including NAG BLAS/LAPACK)
            |       |- libnagc_nag.so   (symbolic link pointing at
            |- lib -|                    libnagc_nag.so.24)
            |       |- libnagc_mkl.a    (static library requiring
            |       |                    vendor BLAS/LAPACK)
            |       |- libnagc_mkl.so.24 (shareable library requiring
            |       |                    vendor BLAS/LAPACK)
            |       |- libnagc_mkl.so   (symbolic link pointing at
            |                            libnagc_mkl.so.24)
cllux24dcl -|
            |- include -|- *.h
            |
            |            |- source --|- ??????e.c
            |            |
            |- examples -|- data ----|- ??????e.d
            |            |           |- ??????e.opt
            |            |
            |            |- results -|- ??????e.r
            |
            |- scripts -|- nagc_example*
            |
            |- mkl_11.1.1 -|- * (Intel Math Kernel Library)
            |
            |- rtl -|- * (Intel run-time libraries)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

libnagc_mkl.a and libnagc_mkl.so do not contain the NAG versions of the BLAS and LAPACK routines (except for any routines listed in Section 4(a) of the Users' Note).

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

nagdoc_cl24 -|- index.html
             |
             |- examples -|- baseresults -|- *.r
             |            |- source      -|- *.c
             |            |- data        -|- *.d, *.opt
             |            |- replaced    -|- *.c
             |
             |- pdf   -|- FRONTMATTER -|- copyright.pdf   (NAG copyright and main
             |         |               |- manconts.html    pdf page)
             |         |               |- manconts.pdf
             |         |
             |         |- [A00-X07] -|- *conts.pdf    (chapter contents)
             |         |             |- *intro.pdf    (chapter introduction)
             |         |             |- *c.pdf        (routine documents)
             |         |             |- *conts.html   (chapter contents (HTML))
             |         |
             |         |- GENINT -|- *.pdf  (general introductory material)
             |         |
             |         |- INDEXES -|- indexnote.pdf (reference to kwic.html)
             |         |           |- kwic.html     (Keywords and GAMS Search)
             |         |                    
             |         |- INUNs -|- usersnote.pdf  (implementation specific note)
             |         |
             |         |- styles -|- libdoc.css    (CSS stylesheet)
             |                    
             |
             |- html  -|- FRONTMATTER -|- manconts.html  (main HTML index)
                       |               |- *.html         (copyright notice)
                       |
                       |- [A00-X07] -|- *conts.html  (chapter contents)
                       |             |- *intro.html  (chapter introduction)
                       |             |- *c.html      (routine documents)
                       |
                       |- figures -|- *.png  (figures and plotfiles)
                       |
                       |- GENINT -|- *.html  (general introductory material)
                       |
                       |- INDEXES -|- kwic.html (Keywords and GAMS Search)
                       |
                       |- styles -|- libdoc.css      (CSS stylesheet)
                                  |- nagmathml.js    (JavaScript)

3.2. File Sizes

The files require approximately the following disk space:

  Library software:  755 MB
  Library Manual:    250 MB

4. Installation

4.1. Installation of Library Software and Manual

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

  gunzip cllux24dcl.tgz
  tar xvf cllux24dcl.tar
This will extract the files install.sh, cl24.tar, lic_agr.txt, in.html and un.html.

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

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

4.1.1. Installation Procedure

You can install the materials from the download directory or CD/DVD 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/cllux24dcl or /usr/local/NAG/cllux24dcl as [INSTALL_DIR]. This convention is also used in the Users' Note (un.html).

The directory [INSTALL_DIR]/scripts contains several 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 this product 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 this product is controlled by the Kusari license management system. This release of the Library uses version 2.2-72 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 either the license/bin/linux_x86/ subdirectory, for Linux (x86-32) systems, or the license/bin/linux_x64/ subdirectory, for Linux 64 systems, 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 CLLUX24DCL), by email 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:

  CLLUX24DC TRIAL 2013/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, the easiest way to install it is to store the text in a file,

  /opt/NAG/nag.key
or
  /usr/local/NAG/nag.key
The license software in this implementation automatically looks for these particular files and reads the first one found, so no other action is necessary. Alternatively, store the license in a file with a name and location of your choice, say,
  [INSTALL_DIR]/license.lic.
The location of the license file, if it is not one of the default places listed above, 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_cl24 directory contains the Library Manual.

compiled libraries:

  libnagc_nag.a
  libnagc_nag.so (symbolic link pointing at libnagc_nag.so.24)
  libnagc_mkl.a
  libnagc_mkl.so (symbolic link pointing at libnagc_mkl.so.24)
  MKL 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 our support team (see below).

(b) NAG Technical Support Service

The NAG Technical Support Service is available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.

The technical support desks are open during office hours, but contact is possible by email and phone (answering machine) at all times.

When contacting us, it helps us deal with your enquiry quickly if you can quote your NAG customer reference number and NAG product code (in this case CLLUX24DCL).

(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 offices (shown below).

Appendix - Contact Addresses

NAG Ltd
Wilkinson House
Jordan Hill Road
OXFORD  OX2 8DR                         Technical Support (Europe & ROW)
United Kingdom                          email: support@nag.co.uk

Tel: +44 (0)1865 511245                 Tel: +44 (0)1865 311744

NAG Inc
801 Warrenville Road
Suite 185
Lisle, IL  60532-4332                   Technical Support (North America)
USA                                     email: support@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2337

Nihon NAG KK
Hatchobori Frontier Building 2F
4-9-9
Hatchobori
Chuo-ku
Tokyo 104-0032                          Technical Support (Japan)
Japan                                   email: naghelp@nag-j.co.jp

Tel: +81 3 5542 6311                    Tel: +81 3 5542 6311