NAG C Library, Mark 23

CLW3223DAL - License Managed

Microsoft Windows XP / Vista / 7, Intel C/C++ or Microsoft 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
operating system:  Microsoft Windows 32-bit (XP / Vista / 7 and compatible)
C compiler:        Intel C++ Compiler (IA-32) version 12.1 and compatible
                   Microsoft 32-bit C/C++ compiler version 16.00 or compatible

2.2. Derivation

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

hardware:         Intel Core2 Quad 2.4 GHz
operating system: Windows Vista Business 32-bit
C compiler:       Intel C++ Compiler XE for applications running on IA-32
                  Version 12.1.0.233 Build 20110811

It has also been tested on a similar machine but with another version of the Intel C compiler:

C compiler:       Intel C++ Compiler XE for applications running on IA-32
                  Version 11.1    Build 20100414

It has also been tested on a similar machine with various versions of the Microsoft C compiler:

C compiler:       Microsoft (R) 32-bit C/C++ Optimizing Compiler
                  Version 16.00.40219.01
                  Version 15.00.21022.08
                  Version 14.00.50727.762

The NAG C Library, Mark 23, 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 23 Library Manual, which we will refer to as the Library Manual).

The library has also been tested with MKL Version 10.3 as supplied with the Intel C++ distribution listed above. The MKL Version 10.3 libraries are supplied as a part of this product (see contents).

Please see the Intel web site for further information about MKL (http://www.intel.com/software/products/mkl).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/cl23/w32dal/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 folder and file organization of the implementation materials as they will be installed. By default, the NAG C Library materials will be installed under C:\Program Files\NAG\CL23\.
            |- doc -|- in.html  (Installer's Note - this document)
            |       |- un.html  (Users' Note)
            |       |- lic_agr.txt (licence agreement)
            |
            |         |- nagc_example_*.bat (Batch files to compile
            |         |                 and run NAG example programs)
            |- batch -|
            |         |- envvars.bat (Batch file to set environment
            |         |             variables for the NAG C Library)
            |
            |       |- CLW3223DA_nag.dll (DLL including NAG BLAS/LAPACK)
            |- bin -|- CLW3223DA_mkl.dll (DLL requiring MKL BLAS/LAPACK)
            |       |- plus various compiler support libraries
            |
            |            |- source --|- ??????e.c
            |- examples -|- data ----|- ??????e.d, ??????e.opt
            |            |- results -|- ??????e.r
            |
clw3223dal -|- include -|- *.h
            |
            |       |- CLW3223DA_nag.lib (DLL import library
            |       |                     including NAG BLAS/LAPACK)
            |       |
            |       |- CLW3223DA_mkl.lib (DLL import library
            |       |                     requiring MKL BLAS/LAPACK)
            |       |
            |- lib -|- nagc_nag_MT.lib (static library including
            |       |                   NAG BLAS/LAPACK compiled with /MT)
            |       |
            |       |- nagc_mkl_MT.lib (static library requiring
            |       |                   MKL BLAS/LAPACK compiled with /MT)
            |       |
            |       |- nagc_nag_MD.lib (static library including
            |       |                   NAG BLAS/LAPACK compiled with /MD)
            |       |
            |       |- nagc_mkl_MD.lib (static library requiring
            |       |                   NAG BLAS/LAPACK compiled with /MD)
            |       |
            |       |- plus various compiler support libraries
            |
            |- diagnostics -|- NAG_C_DLL_info.exe
            |
            |- MKL_ia32_10.3 -|- * (Intel Math Kernel Library)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

The library nagc_nag_MT.lib is a static library that includes NAG BLAS/LAPACK. The library nagc_mkl_MT.lib is a static library that does not include BLAS/LAPACK. Both libraries have been compiled with the /MT option to link with the static multi-threaded C run time library. This option must be used when compiling applications to be linked with either of these libraries to ensure linking to the correct C run time libraries.

The library nagc_nag_MD.lib is an alternate version of the static library that includes NAG BLAS/LAPACK and is compiled with the /MD option. The library nagc_mkl_MD.lib is a static library that does not include BLAS/LAPACK. Both libraries have been compiled with the /MD option to link with the multi-threaded DLL C run time library. The /MD option must be used when compiling applications to be linked with either of these libraries to ensure linking to the correct C run time libraries.

CLW3223DA_nag.lib is a DLL import library that includes NAG BLAS/LAPACK. CLW3223DA_mkl.lib is a DLL import library that does not include BLAS/LAPACK. Both libraries have been compiled with the /MD option to link with the multi-threaded DLL C run time library. This option must be used when compiling applications to be linked with either of these libraries to ensure linking to the correct C run time libraries.

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

nagdoc_cl23 -|- 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-X04] -|- *conts.pdf    (chapter contents)
             |         |             |- *intro.pdf    (chapter introduction)
             |         |             |- *c.pdf        (routine documents)
             |         |             |- *conts.html   (chapter contents (HTML))
             |         |
             |         |- GENINT -|- *.pdf  (general introductory material)
             |         |
             |         |- INDEXES -|- *.pdf (bookmarked file containing links
             |         |                     to kwic.html and gams.html)
             |         |
             |         |- INUNs -|- usersnote.pdf  (implementation specific note)
             |
             |- html  -|- FRONTMATTER -|- manconts.html  (main HTML index)
                       |               |- *.html         (copyright notice)
                       |
                       |- [A00-X04] -|- *conts.html  (chapter contents)
                       |             |- *intro.html  (chapter introduction)
                       |             |- *c.html      (routine documents)
                       |
                       |- figures -|- *.png  (figures and plotfiles)
                       |
                       |- GENINT -|- *.html  (general introductory material)
                       |
                       |- INDEXES -|- GAMS -|- gams.html  (GAMS index)
                       |           |        |- *.html     (GAMS files)
                       |           |
                       |           |- KWIC -|- kwic.html  (KWIC index)
                       |                    |- *.html     (KWIC files)
                       |
                       |- styles -|- *.css      (CSS stylesheet)
                                  |- *.js       (JavaScript)

3.2. File Sizes

The files require approximately the following disk space:

  Library software:  632 MB
  Library Manual:    220 MB

4. Installation

4.1. Installation of Library Software and Manual

4.1.1. Library Installation

You must have Administrator privileges to install this software.

If you have the Library materials on CD, insert the CD into your CD drive to display the NAG CD browser. Click on the Install Library button and follow the instructions to install the Library. If the CD does not autorun, run

  e:\NAG_Installation_browser.exe
to run the browser, or run e:\clw3223dal_setup.exe to run the Library installation directly, where e is the drive letter for your CD drive.

If you have downloaded the Library materials from our website, run the self-extracting executable to start the Library installation. The Library Manual materials are available as a separate download.

After installation, you should ensure that the software described in Section 3.1 is present and accessible.

If your machine has more than one processor, then it is recommended that you set the environment variable OMP_NUM_THREADS to the number of available processors, e.g.

  set OMP_NUM_THREADS=2
This will enable the Intel MKL BLAS to make use of the extra processor(s) and will thus speed up the computation of many of the Library procedures.

The installation procedure will create a shortcut which starts a Command Prompt with the required local environment variables. The default location of this shortcut is in the Start Menu under

  Start|All Programs|NAG|CL23|NAG C Library (CLW3223DAL)|CLW3223DAL Command Prompt

The local environment variable NAG_CLW3223DAL is needed by the batch files nagc_example_*.bat (see Section 3.1.1. of the Users' Note (un.html)).

The installation procedure also creates a shortcut on the Start Menu to the Users' Note, which by default is located under

  Start|All Programs|NAG|CL23|NAG C Library (CLW3223DAL)|Users' Note

This software is provided with an uninstallation facility via

  Control Panel|Add or Remove Programs
on Windows XP and via
  Control Panel|Programs|Programs and Features|Uninstall a Program
on Windows Vista or Windows 7.

4.1.2. Library Manual Installation

It is not necessary to install the Library Manual. Users may access it directly on the distribution CD, or it may be installed on a different workstation or server, or viewed from the NAG website (http://www.nag.co.uk/numeric/CL/CLdocumentation.asp).

If you have the Library materials on CD, insert the CD into your CD drive to display the NAG CD browser. Click on the Install Documentation button and follow the instructions to install the manual. If the CD does not autorun, run

  e:\NAG_Installation_browser.exe
to run the browser, or run e:\setup_cl23_manual.exe to run the Library manual installation directly, where e is the drive letter for your CD drive.

If you have downloaded the Library Manual materials from our website, run the self-extracting executable to start the Library Manual installation.

The installation will create a shortcut to the main index file for the manual. The default location of this shortcut is in the Start Menu under

  Start|All Programs|NAG|CL23|NAG C Library Manual

Free copies of Adobe Acrobat Reader 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 mathematical characters, such as integral signs, square roots and large brackets.

4.1.3. License Management

The use of this product is controlled by the Kusari license management system. This release of the 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 a simple text file containing details of the software that will be enabled. For evaluation purposes a trial license may be used. Before obtaining a full license you need to know the Kusari hostid of the system on which you intend to use this product. How to do this is described below.

The easiest way to request a license key is to use the Kusari Installer GUI described in the next section. Once you have a key, the same GUI can be used to install it.

The information below covers the most common requirements. For more complex licensing situations, please see the Kusari documentation (the files k-using-win.pdf and k-install-win.pdf in the clw3223dal\license\doc folder).

4.1.3.1. The Kusari Installer license key request and key installation program
The recommended way to request a license key is to use the Kusari Installer GUI program provided. This will help you to build a standard message requesting either a trial key or a full key which can be pasted into an email to the NAG Response Centre. In the case of a full key, the message contains the Kusari hostid.

To request a license key, run the Kusari Installer program, which may be accessed at the end of the installation procedure or via the Start Menu shortcut

  Start|All Programs|NAG|CL23|NAG C Library (CLW3223DAL)|Request or Install License Key
and click on the Request New Licence button to bring up the New Licence Request form. Fill in your details and click on Generate Licence Request, then paste the generated information into your email client and send it to the NAG address given at the top of the generated information.

The NAG Response Centre will send you the Kusari license key by email.

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

  CLW3223DA TRIAL 2010/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 Kusari Installer program may be used to install the key in the Windows Registry. Paste the key into the edit box on the main Kusari Installer dialog and then click on the Install Licence Key button to install it.

4.1.3.2. Command line license key request
If for any reason it is impractical to use the GUI, the command line program khostid may be run instead. The output of this command should be sent to the NAG Response Centre with your details, your organisation details and your NAG Site Reference (if known).

The khostid command may be found in the clw3223dal\bin folder.

4.1.3.3. Command line installation of the license key in the registry
If not using the GUI, the 'klreg' program may be executed from a command prompt to install a key in the registry. This program may be found in the clw3223dal\bin folder. First put the license key in a file, say license.dat. If you have administrator privileges you can install the key for all users,
  klreg CLW3223DA license.dat
Otherwise the key can be installed for the current user,
  klreg /current_user CLW3223DA license.dat
4.1.3.4. Installing the license key in a file
You are recommended to install the license key in the registry as described above. If this is not suitable an alternative method is to put the license key into a file accessible from the machine for which the software is licensed and set the environment variable NAG_KUSARI_FILE to the full pathname of the license file.

The environment variable may be set from the Control Panel.

4.1.3.5. USB key licenses
Simply insert the USB key in any spare USB socket on the machine on which you wish to run this product.
4.1.3.6. Testing the license

The a00acc example program may be used to check the license is properly installed or the diagnostic program NAG_C_DLL_info.exe can be used to check both accessibility and licensing.

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 appropriate batch file, e.g. nagc_example_dll.bat (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 CL23\manual folder contains the online documentation. This should be made available to users, in addition to the following:

compiled libraries:

  lib\*
  bin\*
  MKL_ia32_10.3\lib\*
  MKL_ia32_10.3\bin\*
include files:
  include\*.h
example program material:
  examples\source\*.c
  examples\data\*.d
  examples\data\*.opt
  examples\results\*.r
  batch\nagc_example*.bat
batch file to set environment variables:
  batch\envvars.bat

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 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 the appropriate batch file 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. Documentation

Online documentation is bundled with this implementation. Please see Section 4. See Section 3.1 for online help files in HTML and PDF formats.

6. 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 number and NAG product code (in this case CLW3223DAL).

(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/, http://www.nag-j.co.jp/ or http://www.nag-gc.com/

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

7. 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                          Nihon NAG Response Centre
Japan                                   email: support@nag-j.co.jp

Tel: +81 3 5542 6311                    Tel: +81 3 5542 6311
Fax: +81 3 5542 6312                    Fax: +81 3 5542 6312

NAG Taiwan Branch Office
5F.-5, No.36, Sec.3
Minsheng E. Rd.
Taipei City 10480                       NAG Taiwan Response Centre
Taiwan                                  email: support@nag-gc.com

Tel: +886 2 25093288                    Tel: +886 2 25093288
Fax: +886 2 25091798                    Fax: +886 2 25091798