NAG C Library, Mark 24

CLW3224DAL - License Managed

Microsoft Windows XP / Vista / 7 / 8, 32-bit, 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 Agreement (in file lic_agr.txt, see Section 3.1) 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 / 8 and compatible)
C compiler:        Intel C++ Compiler (IA-32) version 14.0 and compatible
                   Microsoft 32-bit C/C++ compiler version 17.00 or 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 Core i7-3770 3.4 GHz
operating system:  Microsoft Windows 7 x64 Edition
C compiler:        Intel(R) C++ Compiler icl Version 14.0.1.139 Build 20131008

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 17.00.60315.1
                  Version 16.00.40219.01
                  Version 15.00.21022.08

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 C 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 Windows (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/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 after installation.
            |- 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)
            |
            |       |- CLW3224DA_nag.dll (DLL including NAG BLAS/LAPACK)
            |- bin -|- CLW3224DA_mkl.dll (DLL requiring MKL BLAS/LAPACK)
            |       |- plus various compiler support libraries
            |
            |            |- source --|- ??????e.c
            |            |
            |- examples -|- data ----|- ??????e.d
            |            |           |- ??????e.opt
            |            |
            |            |- results -|- ??????e.r
            |
clw3224dal -|- include -|- *.h
            |
            |       |- CLW3224DA_nag.lib (DLL import library
            |       |                     including NAG BLAS/LAPACK)
            |       |
            |       |- CLW3224DA_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
            |
            |- HTMLHelp -|- nagdoc_cl24.chm (Manual in HTML Help format)
            |
            |- mkl_ia32_11.1 -|- * (Intel Math Kernel Library)
            |
            |- rtl -|- * (Intel run-time libraries)
            |
            |           |- 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 (except for any routines listed in Section 4(a) of the Users' Note). Both libraries have been compiled with the /MT option to link with the static multithreaded 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 (except for any routines listed in Section 4(a) of the Users' Note). Both libraries have been compiled with the /MD option to link with the multithreaded 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.

CLW3224DA_nag.lib is a DLL import library that includes NAG BLAS/LAPACK. CLW3224DA_mkl.lib is a DLL import library that does not include BLAS/LAPACK (except for any routines listed in Section 4(a) of the Users' Note). Both libraries have been compiled with the /MD option to link with the multithreaded 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 folder and file organization of the Library Manual materials after installation.

nagdoc_cl24 -|- index.html
             |
             |- examples -|- baseresults -|- *.r
             |            |- source      -|- *.c
             |            |- data        -|- *.d, *.opt
             |            |- replaced    -|- *.c
             |
             |- pdf   -|- FRONTMATTER -|- copyright.pdf   (NAG copyright and
             |         |               |- manconts.html    main 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: 1252 MB
  Library Manual:    247 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 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.

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:\clw3224dal_setup.exe to run the Library installation directly, where e is the drive letter for your CD drive.

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

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|CL24|NAG C Library (CLW3224DAL)|
      NAG CLW3224DAL Command Prompt

(Under Windows 8, the shortcuts appear under the list of all applications. To find this, right-click on the background of the Start screen and click on the All apps button, which is typically located near the bottom left or bottom right corner of the screen. The shortcuts are listed under the NAG section.)

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

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|CL24|NAG C Library (CLW3224DAL)|
      NAG CLW3224DAL Users' Note

This software is provided with an uninstallation facility via

  Control Panel|Add or Remove Programs
on Windows XP, or via
  Control Panel|Programs|Uninstall a Program
or
  Control Panel|Programs and Features|Uninstall or change a program
on Windows Vista, Windows 7 or Windows 8 (depending on which view is displayed).

4.1.2. Library Manual Installation

The Library manual may be installed on a local machine, or viewed from the NAG website (http://www.nag.co.uk/numeric/CL/CLdocumentation.asp).

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

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_cl24_manual.exe to run the Library manual installation directly, where e is the drive letter for your CD drive.

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|Mark 24 Manual
  Start|All Programs|NAG|Mark 24 Manual|
      NAG C Library Manual Mark 24 (HTML5)
  Start|All Programs|NAG|Mark 24 Manual|
      NAG C Library Manual Mark 24 (PDF)
  Start|All Programs|NAG|Mark 24 Manual|
      NAG C Library Manual Mark 24 (PDF + HTML Index)
See Section 5 of the Users' Note for details.

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.

4.1.3. Silent Installation

This product may be installed in silent (unattended) mode by running
  clw3224dal_setup.exe /silent
or
  clw3224dal_setup.exe /verysilent
from a Command Prompt. With the first version, the user sees a progress bar on the screen as the installation occurs, whereas with the second, nothing is displayed. The files will be installed to the default location and the PATH, LIB and INCLUDE environment variables will be modified. The default installation location may be overridden by using the /dir switch, e.g. /dir="C:\my folder". To prevent the environment variables being updated, the /type=noenv option may be used.

Similarly, the /silent or /verysilent flags may also be applied to the Library Manual installer setup_cl24_manual.exe.

4.1.4. 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. 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 clw3224dal\license\doc folder).

4.1.4.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 Technical Support Service. 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|CL24|NAG C Library (CLW3224DAL)|
      Request or Install NAG License Key for CLW3224DAL
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 support team 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:

  CLW3224DA TRIAL 2014/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.4.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 Technical Support Service with your details, your organisation details and your NAG customer reference number (if known).

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

4.1.4.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 clw3224dal\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 CLW3224DA license.dat
Otherwise the key can be installed for the current user,
  klreg /current_user CLW3224DA license.dat
4.1.4.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.4.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.4.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. Further Information

4.2.1. Checking the Installation

Access to the Library materials can be checked by running a few example programs following the advice given in the Users' Note, Section 3.1; a suitable sample would be d01sjc, f07adc and g05sjc. The installation can also be tested using the batch files nagc_example* (see Users' Note, Section 3.2).

4.2.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 one of the nagc_example* batch files 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.

Alternatively, run the diagnostic program NAG_C_DLL_info.exe which itself calls a00aac (see Section 4.2.3).

4.2.3. Accessibility Check

The diagnostic program NAG_C_DLL_info.exe, which by default is located in C:\Program Files\NAG\CL24\clw3224dal\diagnostics, may be used to check whether the DLLs CLW3224DA_nag.dll and CLW3224DA_mkl.dll are accessible from the current environment. If this program is started from Windows Explorer or from the
  Start|All Programs|NAG|CL24|NAG C Library (CLW3224DAL)|
      Check NAG DLL Accessibility for CLW3224DAL
shortcut on the Start Menu, the DLLs will be found if the global PATH environment variable has been set to include their location. If it is run from a Command Prompt window, then the environment local to that window will prevail. (See Section 3.1.1 of the Users' Note for more information on environment variables.)

For each of the DLLs that it loads successfully, NAG_C_DLL_info.exe will print the location of the DLL, and the implementation details as provided by a call to the routine a00aac. It also calls a00acc to check the availability of a valid license key and reports if this is not found; "Status OK" indicates that a valid key was either found or not required.

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

(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