NAG C Library, Mark 7

CLSG607DAL - License Managed

Silicon Graphics (IRIX 6)

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 supplied in printed form to accompany the software, and is also available together with the Users' Note (un.html) in the doc directory on the distribution medium.

Your attention is drawn to the terms and conditions of the Software Licence 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:         Silicon Graphics MIPS III or MIPS IV machines
operating system: IRIX 6.5 or compatible
C compiler:       SGI MIPSpro C/C++ versions 7.3.1.2m, 7.41 and compatible

2.2. Derivation

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

hardware:         Silicon Graphics Origin 3400 (R12000) and Origin 350 (R16000)
operating system: IRIX 6.5
C compiler:       SGI MIPSpro C/C++ versions 7.3.1.2m and 7.41
compiler options: -n32 -mips3 (for MIPS III ISA / n32 ABI)
                  -n32 -mips4 (for MIPS  IV ISA / n32 ABI)
                  -64  -mips3 (for MIPS III ISA / n64 ABI)
                  -64  -mips4 (for MIPS  IV ISA / n64 ABI)

The entire NAG C Library, Mark 7, was compiled with full optimization (-O3), except for the following functions, which had to be compiled at lesser optimization (-O1) level:

c06pcqn     c06pczn     c06pptn     c06pszn     c06puqn     c06puzn
c06pxxn     f06gdf      f06hbf      f06thf      f06zaf      f06zcf
f06zff      f06zjf      f06zpf      f06zrf      f06ztf      f06zuf
f06zwf      f08asf      f08atf      f08auf      f08avf      f08awf
f08axf      f08fgf      f08fsf      f08gqf      f08hqf      f08ksf
f08nsf      f08nsy      f08psf      f08quf(for mips3 only)  f08usf
s17detn     s17deun     s17deyn     s17dgrn     s17dgxn     s17dgzn

and

x03aayt (-O2)
This Library has been tested with the Basic Linear Algebra Subprograms (BLAS) and linear algebra functions (LAPACK) provided by NAG (see the Chapter Introductions for f06, f07 and f08 in the NAG C Library Manual). It has also been tested using the set of BLAS and LAPACK routines supplied by Silicon Graphics in the SGI Scientific Computing Software Library (SCSL) versions 1.4.0.1 and 1.4.1.3.

3. Distribution Medium

The software is ordinarily distributed in tar format on CD-ROM.

3.1. Contents

The following shows the directory/file organization of the library materials as they will be installed.
                      |-- in.html
            |-- doc --|-- un.html
            |         |-- nag_c_un.3
            |
            |-- lib[32|64] --|-- mips[3|4] --|-- *
            |
clsg607dal--|-- include --|-- *.h
            |
            |              |-- source ---|-- ??????e.c
            |-- examples --|-- data -----|-- ??????e.d
            |              |-- results --|-- ??????e.r
            |
            |-- scripts ---|-- nagexample
            |
            |              |-- bin ------|-- * (directories of FLEXlm binaries
            |              |                    for supported platforms)
            |-- license ---|-- README.TXT
                           |
                           |-- htmlman --|-- flexuser --|-- * (End User Guide)
Each of the four directories lib[32|64]/mips[3|4] contains the following four libraries:
libnagc.a libnagc.so libnagc_scs.a libnagc_scs.so.

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

                        |- mark7.html (main index)
                        |
                        |- libdoc.css (cascading style sheet)
                        |
                        |- genint -|- *.html (introductory material)
                        |
                        |          |- *.gif (NAG images)
                        |- images -|
                        |          |- topbar -|- *.gif (C Library images)
               |- html -|
               |        |                    |- gams.html (main GAMS index)
               |        |           |- gams -|
               |        |           |        |- *.html (GAMS files)
               |        |- indexes -|
               |        |           |        |- kwic.html (main KWIC index)
NAGdoc -|- cl -|        |           |- kwic -|
               |        |                    |- *.html (KWIC files)
               |        |
               |        |- [A00-X04] -|- *conts.html (chapter indexes)
               |
               |       |- frontmatter -|- mark7.pdf (NAG copyright)
               |       |
               |       |- genint -|- *.pdf (introductory material)
               |       |
               |- pdf -|- indexes -|- *.pdf (index note)
               |       |
               |       |- INUNs -|- *.pdf (implementation-specific note)
               |       |
               |       |- [A00-X04] -|- *.pdf (chapter and routine files)
               |
               |- examples -|- vrb -|- *.txt (miscellaneous example files)

3.2. File Sizes

The files require approximately the following disk space:
each archive library:        30.9-38.2 Mb
each shareable library:      17.8-19.0 Mb
include files:                     0.3 Mb
example program material:          8.8 Mb
library documentation files:        65 Kb
scripts:                             4 Kb
PDF documentation files:            87 Mb
licensing materials                 50 Mb

4. Installation

4.1. Library Installation

To install all material use the Unix tar utility, e.g.

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

The installer should decide on which of the eight archive and the eight corresponding shareable libraries should be installed. To install, use the Unix tar utility to read documentation, compiled libraries, include files and examples, e.g.

cd /opt
tar xvf /cdrom/cl07.tar clsg607dal/doc clsg607dal/lib32/mips4 clsg607dal/include \
                        clsg607dal/examples clsg607dal/scripts

for the MIPS IV / n32 libraries.

It is advisable that the libraries are kept in the installed directory, /opt/clsg607dal, and appropriate symbolic links 'libnagc.a' and 'libnagc.so' made to them from the appropriate system library directories where the linker (ld) will find them, e.g.

ln -s /opt/clsg607dal/lib32/mips4/libnagc.a /usr/lib32/mips4/libnagc.a
ln -s /opt/clsg607dal/lib32/mips4/libnagc.so /usr/lib32/mips4/libnagc.so
ln -s /opt/clsg607dal/lib32/mips4/libnagc_scs.a /usr/lib32/mips4/libnagc_scs.a
ln -s /opt/clsg607dal/lib32/mips4/libnagc_scs.so /usr/lib32/mips4/libnagc_scs.so
for the MIPS IV / n32 libraries.

For the MIPS III / n32 libraries the appropriate directory is /usr/lib32/mips3. For the MIPS III and MIPS IV / n64 libraries the appropriate directories are /usr/lib64/mips3 and /usr/lib64/mips4 respectively.

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 script nagexample refers to the local directory containing the example programs. The file should be copied to (for example) /usr/local/bin, modified to reflect the local installation, and its protection set to world execute.

The man page, which directs users to the HTML form of the Users' Note, should be modified to reflect the local installation, and moved to a directory in the man search path, e.g.

cd doc
mv nag_c_un.3 /usr/local/man/man3

4.1.1. License Management

The use of the NAG C Library is controlled by the FLEXlm network license management system (FLEXlm is a registered trademark of Globetrotter Software Inc). This release of the NAG C Library uses version 9.2 of FLEXlm.

In order to enable the software, NAG will issue you with a license key. The license key is a simple text file (usually called license.dat), containing details of the software that will be enabled.

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

FEATURE NAG_CL NAG 7.000 10-apr-2002 0 CBDA2041DC1BC45D2B68 "ANY" DEMO
Specifically, it does not have any lines starting with the word SERVER 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 FLEXlm hostid of the computer instead of the word DEMO above.

To apply for a longer term license key, contact one of the NAG Response Centres quoting the product to be licensed and the FLEXlm hostid for the computer. To obtain the FLEXlm hostid, select the appropriate lmutil program from the platform specific directory under the license/bin/ subdirectory, and run it with argument lmhostid:

license/bin/sgi32_u6/lmutil lmhostid

license/bin/sgi64_u6/lmutil lmhostid

for n32 and n64 libraries respectively.

On systems without an ethernet card, use the arguments lmhostid -long.

Once you have obtained the license key, store the text of it in a file, say /usr/local/lib/nag/license.dat.

The location of this file must be made known to the NAG application by setting the environment variable LM_LICENSE_FILE to the full pathname of the file before the application is invoked.

For example, in the C-shell, type:

setenv LM_LICENSE_FILE /usr/local/lib/nag/license.dat
or in the Bourne shell, type:
LM_LICENSE_FILE=/usr/local/lib/nag/license.dat
export LM_LICENSE_FILE
No other actions are required to install an uncounted license.

Further details about FLEXlm and how it may be configured to suit your local circumstances are included in the FLEXlm End Users Guide supplied in the license/htmlman/flexuser/ subdirectory.

4.2. PDF Documentation Installation

To install all PDF documentation material, use the Unix tar utility, e.g.
tar xvf /cdrom/pdf.tar
(assuming the CD-ROM has been mounted as /cdrom).

You may wish to move the PDF documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users, but in such a way that they are not generally accessible from outside your site.

If you do not already have a copy of Adobe Acrobat Reader for your platform, a free copy can be downloaded from http://www.adobe.com/. Please check this site for availability of a reader for your platform.

Please note that if you are using Adobe Acrobat 4.0 or earlier you might experience some problems when printing documents that contain non-standard characters, such as integral signs, square roots and large brackets. These characters will print correctly using Adobe Acrobat 5.0.

The HTML form of the Essential Introduction contains some mathematical characters that are displayed as question marks by releases of Netscape earlier than 6, but these are displayed correctly by Netscape 6 and Internet Explorer. They may also be viewed via the PDF.

If using Netscape, it might be necessary to re-install Acrobat to ensure that the Acrobat plug-in has been installed. If the plug-in has not been installed, Netscape may copy PDF files to a temporary directory, and then not be able to navigate from there.

4.3. Release to Users

The Users' Note (doc/un.html) should be checked and amended as necessary (particularly Sections 3.1 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 a02bac, d01ajc, g05ffc and s17akc (and f07adc, if you are using SCSL libraries). The installation can also be tested using the script nagexample. 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 directory contains the online documentation.

One or more of compiled libraries as appropriate:

lib[32|64]/mips[3|4]/libnagc.a
lib[32|64]/mips[3|4]/libnagc.so
lib[32|64]/mips[3|4]/libnagc_scs.a
lib[32|64]/mips[3|4]/libnagc_scs.so
Include files:
include/*.h
Example program material:
examples/source/??????e.c
examples/data/??????e.d
examples/results/??????e.r
scripts/nagexample

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.4 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.4. Example Programs

The example results distributed were generated at Mark 7, using a static library libnagc.a and the Silicon Graphics MIPSpro compiler Version 7.3.1.2m (cc). 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 functions). 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 "example programs" for the functions in the f06 chapter are not typical example programs and they are not in the Library Manual. They are test programs, which are supplied to sites for use in an installation test of the Library.

4.5 Maintenance Level

The maintenance level of the library can be determined by writing a simple program to call a00aac, which prints out details of the implementation, including title and product code, compiler and precision used, mark and maintenance level.

5. Documentation

Each supported NAG C Library site is ordinarily provided with a printed copy of the NAG C Library Introductory Guide. Additional documentation is available for purchase; please refer to the NAG websites or contact your local NAG Response Centre for current prices (see Section 6).

Online documentation is bundled with this implementation. Please see Section 4.2.

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 CLSG607DAL).

(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

http://www.nag.co.uk/, http://www.nag.com/ (in North America) or http://www.nag-j.co.jp/ (in Japan)

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

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 your local NAG Response Centre (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: infodesk@nag.com
 
Tel: +1 630 971 2337                    Tel: +1 630 971 2345
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