NAG Fortran Library, Mark 23

FLW3223DCL - License Managed

Windows XP/Vista/7, 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 Fortran 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 Fortran Library that is considered suitable for operation on the computer systems detailed below:
hardware:         x86-32 systems
operating system: Microsoft Windows XP/Vista/7
Fortran compiler: Intel(R) Fortran Compiler for 32-bit applications
                  Version 12.0 and compatible (including Version 11.1)

2.2. Derivation

This implementation was produced at NAG Ltd., Oxford on the computing system detailed below:
hardware:         Intel(R) Core2 Quad CPU Q6600  2.40GHz
operating system: Microsoft Windows Vista 32-bit
Fortran compiler: Intel(R) Fortran Compiler ifort Version 12.0.1.127
                  Build 20101116

It has also been tested on the same system with another version of the Intel compiler:

                  Intel(R) Fortran Compiler ifort Version 11.1
                  Build 20091012 Package ID: w_cprof_p_11.1.051

It has also been tested on a Windows XP Service Pack 3 system with another version of the Intel compiler:

                  Intel(R) Fortran Compiler ifort Version 10.0
                  Build 20070613 Package ID: W_FC_C_10.0.026

The NAG Fortran Library, Mark 23, was compiled with the highest level of optimization that enabled the functionality provided by the library to be verified and validated. Most files were compiled with compiler flags:
-O3 -QxSSE2.

It was necessary to compile some code without full optimization.

This library has been tested using the Basic Linear Algebra Subprograms (BLAS) and linear algebra routines (LAPACK) provided by NAG (see the Chapter Introductions for F06, F07 and F08 in the NAG Mark 23 Library Manual, which we will refer to as the Library Manual).

The library has also been tested with version 10.3 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 (http://www.intel.com/software/products/mkl).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/fl23/w32dcl/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.
                    |- in.html  (Installer's Note, (this document))
            |- doc -|- un.html  (Users' Note)
            |       |- lic_agr.txt
            |
            |         |- nag_example_*.bat  (Batch files to compile
            |         |                and run NAG example programs)
            |- batch -|
            |         |- envvars.bat  (Batch files to set environment
            |                          variables for the NAG Library)
            |
            |       |- FLW3223DC_nag.dll  (DLL including
            |       |                      NAG BLAS/LAPACK)
            |       |
            |- bin -|- FLW3223DC_mkl.dll  (DLL requiring
            |       |                      MKL BLAS/LAPACK)
            |       |
            |       |- *  (Other support files)
            |
flw3223dcl -|
            |       |- FLW3223DC_nag.lib  (DLL import library
            |       |                      including NAG BLAS/LAPACK)
            |       |
            |       |- FLW3223DC_mkl.lib  (DLL import library
            |       |                      requiring MKL BLAS/LAPACK)
            |       |
            |- lib -|- nag_nag_MT.lib  (static library including
            |       |                   NAG BLAS/LAPACK compiled with /MT)
            |       |
            |       |- nag_mkl_MT.lib  (static library requiring
            |       |                   MKL BLAS/LAPACK compiled with /MT)
            |       |
            |       |- nag_nag_MD.lib  (static library including
            |       |                   NAG BLAS/LAPACK compiled with /MD)
            |       |
            |       |- nag_mkl_MD.lib  (static library requiring
            |                           MKL BLAS/LAPACK compiled with /MD)
            |
            |- nag_interface_blocks -|- *
            |
            |            |- source --|- ??????e.f90
            |- examples -|- data ----|- ??????e.d, ??????e.opt
            |            |- results -|- ??????e.r
            |
            |- samples -|- c_examples -|- *
            |           |- cpp_examples -|- *
            |
            |- c_headers -|- nagmk23.h     (C/C++ header file)
            |             |- techdoc.html  (C/C++ headers documentation)
            |
            |- diagnostics -|- NAG_Fortran_DLL_info.exe
            |
            |- rtl -|- compiler run-time libraries
            |
            |- MKL_ia32_10.3 -|- *  (Intel Math Kernel Library)
            |
            |           |- bin -|- * (directories of binaries
            |           |             for supported platforms)
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)

nag_nag_MT.lib is a static library that includes NAG BLAS/LAPACK. nag_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 multithreaded 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 run-time libraries.

FLW3223DC_nag.lib is a DLL import library that includes NAG BLAS/LAPACK. FLW3223DC_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 multithreaded DLL 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 run-time libraries.

nag_nag_MD.lib and nag_mkl_MD.lib are alternative versions of the static libraries nag_nag_MT.lib and nag_mkl_MT.lib. They are provided for applications which require the multithreaded DLL run-time library to be used.

By default, flw3223dcl is installed beneath the folder C:\Program Files\NAG\FL23\.

The following shows the folder and file organization of the Library Manual materials as they will be installed. By default, nagdoc_fl23 is installed beneath the folder C:\Program Files\NAG\FL23\.

nagdoc_fl23 -|- 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
             |                                       note)
             |
             |- 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:  482 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:\flw3223dcl_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 or a multicore chip, then it is recommended that you set the environment variable OMP_NUM_THREADS to the number of available threads, e.g.

  set OMP_NUM_THREADS=2
This will enable the Intel MKL BLAS to make use of the extra processor(s) / core(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|FL23|NAG Fortran Library -
      Intel Fortran (FLW3223DCL)| Command Prompt

The local environment variable NAG_FLW3223DCL is needed by the batch files nag_example*.bat (see Section 3.3 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|FL23|NAG Fortran Library -
      Intel Fortran (FLW3223DCL)| Users' Note

There is also a shortcut to the diagnostic program NAG_Fortran_DLL_info.exe under

  Start|All Programs|NAG|FL23|NAG Fortran Library -
      Intel Fortran (FLW3223DCL)| Check NAG DLL Accessibility (FLW3223DCL)
(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.

The installation will create shortcuts to the main index files for the manual. The default location of these shortcuts is in the Start Menu under

  Start|All Programs|NAG|FL23|NAG Fortran Library Manual (XHTML + MathML)
  Start|All Programs|NAG|FL23|NAG Fortran Library Manual (PDF)
  Start|All Programs|NAG|FL23|NAG Fortran Library Manual (PDF + HTML Index)
See Section 5 of the User's Note for details.

Free copies of Adobe Acrobat Reader (which may be used to view PDF files) 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 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-41 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 flw3223dcl\license\doc folder). See also the Kusari FAQ: http://www.nag.co.uk/Kusari/kusari_faq.html.

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|FL23|NAG Fortran Library -
      Intel Fortran (FLW3223DCL)| 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:

  FLW3223DC   TRIAL 2011/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 flw3223dcl\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 flw3223dcl\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 FLW3223DC license.dat
Otherwise the key can be installed for the current user,
  klreg /current_user FLW3223DC 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 nag_example* (see Users' Note, Section 3.3).

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 nag_example* batch files with the argument a00aaf. See Users' Note, Section 3.3. 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\FL23\flw3223dcl\diagnostics, may be used to check whether the DLLs FLW3223DC_nag.dll and FLW3223DC_mkl.dll are accessible from the current environment. If this program is started from Windows Explorer or from the
  Start|All Programs|NAG|FL23|NAG Fortran Library -
      Intel Fortran (FLW3223DCL)|Check NAG DLL Accessibility (FLW3223DCL)
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_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.

Note that this program should be closed after use (by pressing a key to dismiss the window), otherwise performance may be impared.

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 no. and NAG product code (in this case FLW3223DCL).

(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