NAG Library for SMP & Multicore, Mark 23

FSW6I23DCL - License Managed

Windows XP/Vista/7 64-bit, Intel Fortran

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

hardware:          Intel64 and AMD64 systems
operating system:  Microsoft Windows XP/Vista/7 64-bit
Fortran compiler:  Intel(R) 64-bit Fortran Compiler version 12.1 and compatible
                   (including ifort 11.1)
Vendor library:    Intel MKL version 10.3

2.2. Derivation

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

hardware:         AMD Opteron (Barcelona) 2.6 GHz, 8.0 GB RAM
operating system: Microsoft Windows Server 2003 Enterprise x64 Edition
Fortran compiler:  Intel(R) Fortran Compiler ifort Version 12.1.0.233 Build 20110811
vendor library:    Intel MKL version 10.3
compiler options:  -Qopenmp -threads -auto -MD -Qprec -fpp -align -Qfnalign:16

It has also been tested on the same system with other versions of the Intel compiler:

Intel(R) Visual Fortran Compiler ifort Version 11.1.065
         Build 20100414 Package ID: w_cprof_p_11.1.065
Intel(R) Visual Fortran Compiler Version 10.1
         Build 20080602 Package ID: w_fc_p_10.1.024

N.B. for the tests with the Intel compiler version 10.1 it was necessary to recompile the module files in nag_interface_blocks as described in Section 3.3 of the Users' Note, because the distributed module files are incompatible with this compiler version. Also, with this compiler it is only possible to use the DLL version of the NAG Library unless you also have a later Intel compiler installed to get access to its static run-time libraries.

Each routine in the NAG Library for SMP & Multicore, Mark 23, was compiled with the highest level of optimization that enabled the functionality provided by the library to be verified and validated. Most routines in the library were compiled with optimization flags -O3 -QxSSE2; some routines will have been compiled with a lower level of optimization when necessary.

In this implementation:

The library has been tested with MKL version 10.3. This version of MKL is supplied as a part of this product (see contents). Please see the Intel web site for further information about MKL (http://software.intel.com/en-us/intel-mkl).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/fs23/w6idcl/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.
            |- doc -|- in.html  (Installer's Note, (this document))
            |       |- un.html  (Users' Note)
            |       |- lic_agr.txt
            |
            |- bin -|- FSW6I23DC.dll        (DLL library)
            |       |- kusari_key_gui.exe   (Kusari license installer)
            |       |- (plus other required run-time libraries)
            |
            |- lib -|- FSW6I23DC_static.lib  (static library)
            |       |- FSW6I23DC.lib         (DLL import library)
fsw6i23dcl -|
            |- nag_interface_blocks -|- *    (Interface blocks for Intel compiler)
            |
            |- nag_interface_blocks_nagfor -|- *  (Interface blocks for NAG compiler)
            |
            |            |- source --|- ??????e.f90
            |            |
            |- examples -|- data ----|- ??????e.d
            |            |           |- ??????e.opt
            |            |
            |            |- results -|- ??????e.r
            |
            |- samples -|- *
            |
            |- c_headers -|- nagmk23.h     (C/C++ header file)
            |             |- techdoc.html  (C/C++ headers documentation)
            |
            |- vb.net64_headers -|- flvbdnet64.vb  (Declare info for VB.NET)
            |
            |         |- envvars.bat
            |- batch -|- nagsmp_example_static.bat
            |         |- nagsmp_example_dll.bat
            |
            |- diagnostics -|- NAG_Fortran_DLL_info.exe
            |
            |- MKL_intel64_10.3 --|- * (Intel Math Kernel Library 10.3)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

By default, fsw6i23dcl is installed beneath the folder C:\Program Files\NAG\FS23\.

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

nagdoc_fl23 -|- index.html
             |
             |- examples -|- baseresults -|- ??????*.r
             |            |- source      -|- ??????*.f90
             |            |- data        -|- ??????*.d
             |                            |- ??????*.opt
             |
             |- html  -|- FRONTMATTER -|- manconts.html (main HTML index)
             |         |               |- *.html        (foreword & copyright)
             |         |
             |         |- [A00-X05] -|- *conts.html  (chapter contents)
             |         |
             |         |- GENINT -|- *.html  (general introductory material)
             |         |
             |         |- INDEXES -|- GAMS -|- gams.html  (GAMS index)
             |         |           |        |- *.html     (GAMS files)
             |         |           |
             |         |           |- KWIC -|- kwic.html  (KWIC index)
             |         |                    |- *.html     (KWIC files)
             |         |
             |         |- styles -|- libdoc.css  (main CSS stylesheet)
             |
             |- pdf   -|- FRONTMATTER -|- manconts.pdf  (NAG copyright and
             |         |               |                 main pdf page)
             |         |               |- foreword.pdf  (NAG foreword)
             |         |
             |         |- [A00-X05] -|- *conts.pdf    (chapter contents)
             |         |             |- *intro.pdf    (chapter introduction)
             |         |             |- *f.pdf        (routine documents)
             |         |
             |         |- GENINT -|- *.pdf  (general introductory material)
             |         |
             |         |- INDEXES -|- *.pdf (bookmarked file containing links
             |         |                     to kwic.xml and gams.xml)
             |         |
             |         |- INUNS -|- usersnote.pdf   (implementation-specific
             |                                       details)
             |
             |- xhtml -|- FRONTMATTER -|- manconts.xml  (main XHTML index)
                       |               |- *.xml         (foreword & copyright)
                       |
                       |- [A00-X05] -|- *conts.xml  (chapter contents)
                       |
                       |- figures -|- *.png  (figures and plotfiles)
                       |
                       |- GENINT -|- *.xml  (general introductory material)
                       |
                       |- INDEXES -|- GAMS -|- gams.xml  (GAMS index)
                       |           |        |- *.xml     (GAMS files)
                       |           |
                       |           |- KWIC -|- kwic.xml  (KWIC index)
                       |                    |- *.xml     (KWIC files)
                       |
                       |- styles -|- libdoc.css      (main CSS stylesheet)
                                  |- nagmathml.css   (MathML stylesheets)
                                  |- pmathml.css

3.2. File Sizes

The files require approximately the following disk space:
  Library software:  584 MB
  Library Manual:    220 MB
but note that the actual disk space used on any particular machine is dependent on the hard disk allocation unit (cluster) size.

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 ... button and follow the instructions to install the Library and/or the manual. If the CD does not autorun, run

  e:\NAG_Installation_browser.exe
to run the browser, or run e:\fsw6i23dcl_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.

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|FS23|NAG Library for SMP and Multicore (FSW6I23DCL)
                    |FSW6I23DCL Command Prompt
The local environment variable NAG_FSW6I23DCL is needed by the batch files nagsmp_example_static.bat and nagsmp_example_dll.bat (see Section 3.4 of the Users' Note (un.html)).

The NAG Library Interface Blocks define the type and arguments of each user callable NAG Library routine. These are not essential to calling the NAG Library from Fortran programs. Their purpose is to allow the Fortran compiler to check that NAG Library routines are called correctly.

The interface block files (nag_interface_blocks\*) are supplied in both source form and pre-compiled module form. (The source form is only required if the precompiled form is incompatible with the compiler in use.) The location of the interface block files is added to the local INCLUDE environment variable by running the batch file envvars.bat. It may also have been set globally as part of the installation procedure. This is needed so that the compiler can access the modules at the compilation stage.

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|FS23|NAG Library for SMP and Multicore (FSW6I23DCL)
                    |Users' Note
There is also a shortcut to the diagnostic program NAG_Fortran_DLL_info.exe under
  Start|All Programs|NAG|FS23|NAG Library for SMP and Multicore (FSW6I23DCL)
                    |Check NAG DLL Accessibility (FSW6I23DCL)
(see Section 4.2.3).

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

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/numeric/FL/FLdocumentation.asp ). Alternatively, if you have a CD distribution of the Library materials, the Library Manual may be accessed directly from that CD, without the need to install the Manual.

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

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.

If you use Internet Explorer as your web browser, you will require Design Science's MathPlayer plug-in in order to display the MathML mathematical expressions correctly for the XHTML/MathML version of the manual. At the end of the Library Manual installation there is an option to install MathPlayer. Selecting this option runs the MathPlayer 2.0b installation, which will install the MathPlayer files (approximately 2.4 Mb) under

  C:\Program Files\Design Science

MathPlayer may be removed via

  Control Panel|Add or Remove Programs
on Windows XP, or via
  Control Panel|Programs|Programs and Features|Uninstall a Program
or
  Control Panel|Programs and Features|Uninstall or change a program
on Windows Vista or Windows 7 (depending on which view is displayed), but note that clicking on the Change/Remove button for MathPlayer will remove the MathPlayer files without asking for any confirmation.

MathPlayer may also be downloaded from Design Science's web site:

  http://www.dessci.com/en/products/mathplayer/download.htm

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 fsw6i23dcl\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|FS23|NAG Library for SMP and Multicore (FSW6I23DCL)
                    |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:

  FSW6I23DC 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 fsw6i23dcl\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 fsw6i23dcl\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 FSW6I23DC license.dat
Otherwise the key can be installed for the current user,
  klreg /current_user FSW6I23DC 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 A00ACF example program may be used to check the license is properly installed or the diagnostic program NAG_Fortran_DLL_info.exe can be used to check both accessibility and licensing (see Section 4.2.3).

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 D01AUF, E04UCA and F07ADF. The installation can also be tested using the batch files nagsmp_example* (see Users' Note, Section 3.4).

4.2.2. Maintenance Level

The maintenance level of the Library can be determined by compiling and executing the example that calls A00AAF, or you could call one of the nagsmp_example* batch files with the argument a00aaf. 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_Fortran_DLL_info.exe which itself calls A00AAF (see Section 4.2.3).

4.2.3. Accessibility Check

The diagnostic program NAG_Fortran_DLL_info.exe, which by default is located in
  C:\Program Files\NAG\FS23\fsw6i23dcl\diagnostics
may be used to check whether the DLL FSW6I23DC.dll is accessible from the current environment. If this program is started from Windows Explorer or from the
  Start|All Programs|NAG|FS23|NAG Library for SMP and Multicore (FSW6I23DCL)
                    |Check NAG DLL Accessibility (FSW6I23DCL)
shortcut on the Start Menu, the DLL will be found if the global PATH environment variable has been set to include its 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.)

If it loads the DLL successfully, NAG_Fortran_DLL_info.exe will print the location of the DLL, and the implementation details as provided by a call to the routine A00AAF. It also calls A00ACF 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 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 FSW6I23DCL).

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

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