NAG C Library, Mark 26

CLW32261EL - License Managed

Microsoft Windows, 32-bit, Intel C/C++ or Microsoft C/C++

Installer's Note



Contents


1. Introduction

This document provides implementation-specific information relating to the installation of the NAG Library specified in the title.

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 Library that is considered suitable for operation on the computer systems detailed below:

hardware:          Intel ia32 systems and compatible
operating system:  Microsoft Windows 32-bit and 64-bit editions
C compiler:        Intel 32-bit C++ Compiler Version 17.0.4.210 Build 20170411 and compatible
                   Microsoft 32-bit C/C++ Compiler Version 19.10 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 and Additional Test Platforms

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

hardware:         Intel(R) Core(TM) i7-6800K CPU @ 3.40GHz
operating system: Microsoft Windows 10
C compiler:       Intel(R) C++ Compiler Version 17.0.4.210 Build 20170411
                  Microsoft Visual Studio 2017 tools
vendor library:   Intel MKL version 2017.0.3
compiler options: -O3 -QaxCORE-AVX2,AVX,SSE2 -Qfma- -fp:precise

For details of any other systems on which this implementation has been tested, please see the Supplementary Information page on our website.

2.3. Supplementary Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/cl26/w321el/supplementary.html

for details of any new information related to the applicability or usage of this implementation. Details of any other systems on which it has been tested may also be found on this page.

3. Distribution

The software is available to download from any of the NAG websites (see Section 6 for contact details).

3.1. Contents

The following shows the folder and file organization of the implementation materials after installation.
                    |- in.html  (Installer's Note - this document)
            |- doc -|- un.html  (Users' Note)
            |       |- lic_agr.txt  (license 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 Library)
            |
            |       |- CLW32261E_nag.dll  (DLL including NAG BLAS/LAPACK)
            |       |
            |       |- CLW32261E_26.x.x_nag.dll  (a renamed copy of the above DLL
            |       |                             including full version number)
            |       |
            |- bin -|- CLW32261E_mkl.dll  (DLL requiring MKL BLAS/LAPACK)
            |       |
            |       |- CLW32261E_26.x.x_mkl.dll  (a renamed copy of the above DLL
            |       |                             including full version number)
            |       |
            |       |- *.pdb   (debugging symbols for the above libraries)
            |       |
            |       |- (plus other support files)
            |
clw32261el -|
            |       |- CLW32261E_nag.lib  (DLL import library
            |       |                      including NAG BLAS/LAPACK)
            |       |
            |       |- CLW32261E_26.x.x_nag.lib  (a renamed copy of the above
            |       |                      library including full version number)
            |       |
            |       |- CLW32261E_mkl.lib  (DLL import library
            |       |                      requiring MKL BLAS/LAPACK)
            |       |
            |       |- CLW32261E_26.x.x_mkl.lib  (a renamed copy of the above
            |       |                      library including full version number)
            |       |
            |- 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
            |                            MKL BLAS/LAPACK compiled with /MD)
            |
            |- include -|- *.h  (C header files)
            |
            |            |- source --|- ??????e.c
            |            |
            |- examples -|- data ----|- ??????e.d
            |            |           |- ??????e.opt
            |            |
            |            |- results -|- ??????e.r
            |
            |- diagnostics -|- NAG_C_DLL_info.exe  (diagnostics program)
            |               |- NAG_C_DLL_info_CLW32261EL.c  (source of
            |                                               the above)
            |
            |- mkl_ia32_2017.0.3 -|- *  (Intel Math Kernel Library)
            |
            |- rtl -|- *  (Intel compiler run-time libraries)
            |
            |           |- bin -|- *  (directories of license management
            |           |              binaries for supported platforms)
            |- license -|- README.txt
                        |
                        |- doc -|- *  (license management documentation)

The following shows the folder and file organization of the Library Manual materials after installation.

nagdoc_cl26 -|- index.html
             |
             |- examples -|- baseresults -|- *.r.html
             |            |- source      -|- *.c.html (syntax highlighted
             |            |                            source files)
             |            |- data        -|- *.d.html
             |            |               |- *.opt.html
             |            |- replaced    -|- *.c.html
             |
             |- html  -|- frontmatter -|- manconts.html  (main HTML index)
             |         |               |- copyright.html (copyright notice)
             |         |
             |         |- genint -|- *.html  (general introductory material)
             |         |
             |         |- [a00-x07] -|- *conts.html  (chapter contents)
             |         |             |- *intro.html  (chapter introduction)
             |         |             |- *c.html      (routine documents)
             |         |
             |         |- figures -|- *.png  (figures and plotfiles)
             |         |
             |         |- styles -|- *.css  (CSS stylesheets)
             |                    |- *.js   (JavaScript)
             |
             |- pdf   -|- frontmatter -|- manconts.html (main contents page)
                       |               |- manconts.pdf  (main contents page)
                       |               |- copyright.pdf (NAG copyright page)
                       |
                       |- genint -|- *.pdf  (general introductory material)
                       |
                       |- [a00-x07] -|- *conts.html   (chapter contents)
                       |             |- *conts.pdf    (chapter contents)
                       |             |- *intro.pdf    (chapter introduction)
                       |             |- *c.pdf        (routine documents)
                       |
                       |- styles -|- *.css  (CSS stylesheets)
                                  |- *.js   (JavaScript)

Details of the software are given in the Users' Note (un.html).

4. Installation

4.1. Installation of Library Software and Manual

4.1.1. Library Installation

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

By default, the Library materials are installed in

  C:\Program Files\NAG\CL26\clw32261el
or (if a 32-bit Library is installed on a 64-bit machine)
  C:\Program Files (x86)\NAG\CL26\clw32261el
or the equivalent for your locale.

The installation procedure will also create several shortcuts, which are described in this document or in the Users' Note. The default location of these shortcuts is under NAG C Library (CLW32261EL) in the Start Menu or via All apps from the Start screen (depending on your version of Windows).

The environment variable NAG_CLW32261EL is needed by the batch files nagc_example_*.bat (see Section 3.2 of the Users' Note). This is set in the registry as part of the installation procedure. Optionally, the PATH, LIB and INCLUDE environment variables may also be updated during installation.

This software is provided with an uninstallation facility via the Windows Control Panel.

4.1.2. Library Manual Installation

The Library Manual may be installed alongside the Library software, or it may be installed on a different workstation or server, or viewed from the NAG website (http://www.nag.co.uk/content/nag-c-library-manual).

Assuming you have downloaded the Library Manual materials from our website, run the self-extracting executable (setup_cl26-1_manual.exe) to start the Library Manual installation.

By default, the Library Manual materials are installed in

  C:\Program Files\NAG\Mark 26-1 Manual\nagdoc_cl26
or the equivalent for your locale.

The installation will also create shortcuts to the main index files for the manual. The default location of these shortcuts is in the Start Menu or All apps list under NAG Mark 26-1 Manual. See Section 5 of the Users' Note for details.

4.1.3. Silent Installation

This product may be installed in silent (unattended) mode by running
  clw32261el_setup.exe /silent
or
  clw32261el_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 switches may also be applied to the Library Manual installer setup_cl26-1_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-88 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 clw32261el\license\doc folder). See also the Kusari FAQ: http://www.nag.co.uk/content/kusari-frequently-asked-questions.

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. This message will include 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 or All apps shortcut NAG CLW32261EL Licence, Request or Install. 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:

  CLW32261E TRIAL 2017/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 typically include the word NODE or FULL instead of the word TRIAL above and may contain extra fields.

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 clw32261el\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 clw32261el\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 CLW32261E license.dat
Otherwise the key can be installed for the current user,
  klreg /current_user CLW32261E 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 (see Section 4.2.2).

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_*.bat (see Users' Note, Section 3.2).

4.2.2. Accessibility Check

The diagnostic program NAG_C_DLL_info.exe, which by default is located in C:\Program Files\NAG\CL26\clw32261el\diagnostics, may be used to check whether the DLLs CLW32261E_nag.dll and CLW32261E_mkl.dll are accessible from the current environment. If this program is started from Windows Explorer or from the Check NAG CLW32261EL DLL Accessibility shortcut via the Start Menu or All apps, 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.

Note: the diagnostics program executable may not be compatible with all versions of Microsoft Windows (in particular, Microsoft Windows XP), and you may get a "not a valid application" error when you try to run it. In that case, you may simply recompile the diagnostics program yourself from the source code provided in the same directory as the executable, using either a Microsoft or an Intel C compiler.

5. Support from NAG

Please see

http://www.nag.co.uk/content/nag-technical-support-service

for information about the NAG Technical Support Service, including details of the NAG Technical Support Service contact points. We would also be delighted to receive your feedback on NAG's products and services.

6. Contact Addresses

Please see

http://www.nag.co.uk/content/worldwide-contact-information

for worldwide contact details for the Numerical Algorithms Group.