NAG C Library, Mark 8

CLMI608DGL License Managed

Apple Macintosh (Intel-based), Mac OS X 64, gcc

Installer's Note


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:          Intel-based Apple Macintosh systems or compatible
operating system:  Mac OS X 64 version 10.4.11 (Tiger) and compatible
C compiler:        Gnu C Compiler, 
                   supplied in the Developer Tools or compatible

2.2. Derivation

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

hardware:          Apple Imac
operating system:  Mac OS X version 10.4.11 (Tiger)
                   Darwin Kernel Version 8.11.1
C compiler:        i686-apple-darwin8-gcc-4.0.1 (GCC)
                   4.0.1 (Apple Computer, Inc. build 5370)

This implementation has also been tested on the same hardware, using the software system detailed below:

hardware:          Apple Imac
operating system:  Mac OS X version 10.5.1 (Leopard)
                   Darwin Kernel Version 9.1.0
C compiler:        i686-apple-darwin8-gcc-4.0.1 (GCC)
                   4.0.1 (Apple Computer, Inc. build 5465)

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, f08 and f16 in the NAG C Library Manual).

The library has also been tested with the Apple Computer's vecLib version 3.3.1.

3. Distribution Medium

The software is ordinarily distributed in dmg (Disk Image) 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.dylib (shareable self-contained library
            |- lib -|                     including NAG BLAS/LAPACK)
            |       |- libnagc_vl.a      (static library requiring
            |       |                     Apple vecLib)
            |       |- libnagc_vl.dylib  (shareable library requiring
            |                             Apple vecLib)
clmi608dgl -|
            |- include -|- *.h
            |            |- source --|- ??????e.c
            |- examples -|- data ----|- ??????e.d
            |            |- results -|- ??????e.r
            |- scripts -|- nagc_example*
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |- doc -|- * (End User Guide)

The following shows the directory/file organization of the Library Manual 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       21.4 Mb
  libnagc_nag.dylib   14.6 Mb
  libnagc_vl.a        21.2 Mb
  libnagc_vl.dylib    14.6 Mb
include files:         0.7 Mb
example program material:               4.2 Mb
scripts:                                  9 Kb
implementation specific documentation:   38 Kb
Library Manual:                         179 Mb
licensing materials                     5.4 Mb

4. Installation

4.1. Installation of Library Software and Manual

4.1.1. Library Software Installation

To install the Library Software, double click on clmi608dgl.pkg and follow the instructions.

By default, the Library Software will be installed in /opt/NAG/. As the installer, you may wish to choose a different location. In this document we refer to the directory /opt/NAG/clmi608dgl or the directory specified by the installer 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.

4.1.2. Library Manual Installation

To install the Library manual, double click on "NAG C Library Manual, cl08_doc.pkg".

By default, the Library Manual will be installed in /opt/NAG/ however it can be installed to some other location of the installer's choice. For example you may wish to install the Library Manual in 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 C Library is controlled by the Kusari license management system. This release of the NAG C Library uses version 2.2 of Kusari.

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

CLMI608DG TRIAL 2007/10/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.

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.

License key request and installation is performed through the Apple Installer when clmin08dal.pkg is installed. During installation, you will be prompted for a license key. If you do not have a license key, a request form will be generated for you to complete and send to NAG via fax or e-mail.

Once you have obtained one of the above license keys you can enter it into the installer. By default, the installer will save the license key in /opt/NAG/nag.key (prepend the file if it exists). The C Library will then validate the license at runtime.

If you need to update or change the license key after installation, we recommend that you run the installer again.

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 installation directory [INSTALL_DIR] (see Section 3.1).

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 script 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 Library Manual. This should be made available to users, in addition to the following:

compiled libraries:

Include files:
example program material:

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

For best performance we recommend that you should use the variant of the NAG C Library which is based on the Apple vecLib library i.e. libnagc_vl.a or libnagc_vl.dylib. However if you use a version of the Apple vecLib library that is 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.dylib.

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, or different arithmetic hardware). 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 nagc_example*.

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, 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 (in this case CLMI608DGL).

(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:, or

(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

(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

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

Wilkinson House
Jordan Hill Road
OXFORD  OX2 8DR                         NAG Ltd Response Centre
United Kingdom                          email:

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

801 Warrenville Road
Suite 185
Lisle, IL  60532-4332                   NAG Inc Response Center
USA                                     email:

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

Tel: +81 (0)3 5542 6311
Fax: +81 (0)3 5542 6312