NAG Toolbox for MATLAB®

MBW6I24DDL

Microsoft Windows, MATLAB R2013a - R2013b

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 Toolbox for MATLAB.

Your attention is drawn to the terms and conditions of the Software License Agreement (in file lic_agr.txt) regarding the use of NAG software. Any request to use this software other than on the licensed computer must be referred to NAG, as should requests for information about the availability of other implementations.

2. Implementation Provided

2.1. Applicability

This implementation is a compiled, tested, ready-to-use version of the NAG Toolbox for MATLAB that is considered suitable for use on the computer systems detailed below:

hardware:             x86-64 systems and compatible
operating system:     Microsoft Windows Vista/7/8
MATLAB version:       64-bit: 8.1 (R2013a), 8.2 (R2013b)

The user needs to have MATLAB installed. This implementation may work with later versions of MATLAB. More details may be available on the post release page (see Section 2.3).

Note that this implementation will not work with 32-bit versions of MATLAB; please use an appropriate 32-bit NAG Toolbox instead.

2.2. Precision

For compatibility with MATLAB, this implementation uses 64-bit integers.

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/mb24/w6iddl/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 websites (see NAG Websites under Section 6). Upon request, the software may be distributed by CD.

3.1. Contents

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

                        |- ?????.mexw64  (MEX-files, short function names)
                        |
                        |- nag_*.mexw64  (MEX-files, long function names)
                        |
                        |- nag_int*.m    (Helper function source files)
mbw6i24ddl -|- mex.w64 -|
            |           |- MBW6I24DD.dll (NAG Library DLL)
            |           |
            |           |- *.dll         (Supporting run-time libraries)
            |           |
            |           |- *             (Other support files)
            |
            |- help -|- NAG -|- * (Help files and demo materials)
            |
            |- doc -|- in.html (Installer's Note (this document))
                    |
                    |- lic_agr.txt (Licence Agreement)

By default these files are installed under C:\Program Files\NAG\MB24 . Note that due to changes in MATLAB from version 8.0 (R2012b), we no longer recommend installing the NAG files within the MATLAB hierarchy.

3.2. File Sizes

The installation requires approximately 406MB of free space. The actual disk space used is dependent on the hard disk allocation unit (cluster) size.

4. Installation

You must have Administrator privileges to install this software.

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

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

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

Note that we recommend that you install a separate instance of the toolbox for each version of MATLAB that you wish to use it with. However, if you install a new release of MATLAB and wish to use an existing installation of the toolbox with it, then this is possible by following the instructions in Section 4.1.1.

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

You should access the toolbox documentation as follows. On starting the MATLAB documentation browser you should see a link labelled Supplemental Software. Clicking on that should open a browser with the entry NAG Toolbox in the Contents list.

A quick test that the software has been correctly installed is to type a00aa at the MATLAB prompt, which should print some implementation details. If this does not work correctly and you see messages such as "The referenced assembly is not installed on your system." then it may be necessary to reboot your computer so that MATLAB picks up the correct support libraries.

To test that a valid license is available, type a00ac at the MATLAB prompt. This will return 1 if a valid license is found, or 0 otherwise.

This software is provided with an uninstallation facility via

  Control Panel|Programs|Uninstall a Program
or
  Control Panel|Programs and Features|Uninstall or change a program
(depending on which view is displayed).

Running the setup program again will allow you to install another instance of the toolbox to a different location (e.g. for use with a different release of MATLAB).

4.1. Installation Options

4.1.1. Updating the MATLAB path

If you choose to have your MATLAB path updated during installation, the file toolbox\local\pathdef.m in your MATLAB installation will be modified. If you choose not to have your path modified, or you wish to use an existing toolbox installation with a new installation of MATLAB, then there are a number of ways by which this may be done by hand. The easiest is to use the Set Path button on the MATLAB GUI, but if you search for "matlab path" in the MATLAB online help system you will find pointers to several others. If updating by hand then it is essential to ensure that the folder containing the help files appears after that containing the executable files. For example, if you installed the toolbox under C:\Program Files\NAG\MB24\mbw6i24ddl then your MATLAB path should contain the folders:

in that order.
4.1.2. Setting the number of processors to use
This implementation of the NAG Toolbox for MATLAB is based on OpenMP and many routines have been specially tuned to make use of shared memory parallelism and the processing power available.

If the environment variable OMP_NUM_THREADS is not already set, you may optionally set it to either one or the maximum number of processors available on your system (or leave it unset), as part of the installation procedure, either for all users or for the current user only. (If it is already set, the existing value is not changed.)

Alternatively, the OMP_NUM_THREADS environment variable may be set from the Control Panel:

You will need to restart MATLAB for this change to take effect.

4.2. Silent Installation

This product may be installed in silent (unattended) mode by running
  mbw6i24ddl_setup.exe /SILENT
or
  mbw6i24ddl_setup.exe /VERYSILENT
from a Command Prompt. With the first version, the user sees what is happening on the screen as the installation procedure progresses, whereas with the second, nothing is displayed. The files will be installed to the default location, the MATLAB path file (pathdef.m) will be modified but the OMP_NUM_THREADS environment variable will not be modified. The default location may be overridden by using the /DIR flag, e.g. /DIR="C:\my folder". To prevent the MATLAB path being updated, the /TYPE=nopathdef option may be used.

4.3. License Management

The use of this product is controlled by the Kusari license management system. This release uses version 2.2-58 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. To get a trial license contact the NAG Response Centre. Before obtaining a full license you need to know the Kusari hostid of the system on which you intend to use this product and how to do this is described below.

The easiest way to request a license key is to use the 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 contact us.

4.3.1. The GUI license key request and key installation program
The recommended way to request a license key is to use the 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.

Once you have your license key, the same GUI can be used to install the key in the registry.

You can execute this GUI from

  Start|All Programs|NAG|Toolbox for MATLAB Mark 24|
      Request or Install License Key for MBW6I24DDL
(Under Windows 8, the shortcut appears under the list of all applications. To find this, right-click on the background of the Start screen and select All apps from the bottom right hand corner of the screen. The shortcuts are listed under the NAG section.)

This GUI can also be run from the installation procedure.

4.3.2. USB key licenses (subject to availability and commercial agreement)
Simply insert the USB key in any spare USB socket on the machine on which you wish to run this product.

5. Documentation

On-line documentation, accessible via the standard MATLAB help facilities, is bundled with this implementation. Please see Section 3.1.

6. Support from NAG

NAG will provide free support for this product for a period of 90 days from the date of purchase. Beyond that period, support will continue to be provided for users who have an appropriate support agreement.

(a) 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 MBW6I24DDL).

(b) 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/

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

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