NAG Toolbox for MATLAB

MBL6A22DJL

x86-64 Linux

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 regarding the use of NAG software.

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:     Linux 2.6.26 and compatible
MATLAB Version:       7.8 (R2009a), 7.9 (R2009b)

The user needs to have MATLAB installed. This implementation will not work with earlier versions of MATLAB such as 7.7 (R2008b), but may work with later versions.

2.2. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/mb22/l6adjl/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.

3.1. File Sizes

The approximate files sizes are given below
Help material    25Mb
Toolbox files    85Mb

4. Installation

If you downloaded this product from NAG as a compressed tar file then you should unpack it as follows. Create a temporary directory and unpack the file mbl6a22djl.tgz into it, for example using the commands:
mkdir nagtmp
cd nagtmp
tar -xzf ../mbl6a22djl.tgz
If you received the product on CD then simply insert it in your CD drive and, if necessary, mount the CD device (normally this will happen automatically).

If you are upgrading an existing installation of the toolbox you are strongly advised to uninstall it using the UNINSTALL.a64 script which can be found in the directory toolbox/NAG, using the command

 sh UNINSTALL.a64
If you are unsure where the existing installation is installed, then type which a00aa at the MATLAB prompt. This should return a string like:
/usr/local/matlab/toolbox/NAG/mex.a64/a00aa.mexa64
which indicates that the UNINSTALL.a64 script can be found in
/usr/local/matlab/toolbox/NAG

Run the INSTALL script by typing "sh INSTALL". This will prompt you for the location in which you wish to install the product, which typically should be under your existing MATLAB installation. It is possible to install the product elsewhere but if you do so you will need to update your MATLAB path manually, as described in Section 4.1.

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

If you have installed the help material, then on starting the MATLAB Help browser you should see the entry NAG (64 bit) 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.

4.1. Installation Options

By default, MBL6A22DJL is installed under your MATLAB installation. The help files will be placed in the directory help/toolbox/NAG while the executable files will be placed in toolbox/NAG/mex.a64.

If you choose to have your MATLAB path updated during installation, the file toolbox/local/pathdef.m will be modified. If you install the toolbox under /MyMatlab then this file will have the lines:

     '/MyMatlab/toolbox/NAG/mex.a64:' ...
     '/MyMatlab/help/toolbox/NAG:' ...
     '/MyMatlab/help/toolbox/NAGToolboxDemos:' ...
inserted. If you choose not to have your path modified then there are a number of ways by which this may be done by hand. Search for "matlab path" in the MATLAB online help system for one method, and for pointers to several others. If updating by hand then it is essential to ensure that the directory containing the help files appears after that containing the executable files. For example, if you installed the toolbox under /MyMatlab then your MATLAB path should contain the directories: in that order.

If you choose to modify your MATLAB script during installation then the file bin/matlab in the MATLAB distribution will have the lines:

  # Inserted during installation of NAG Toolbox for 64 bit Linux
  LD_LIBRARY_PATH=/MyMatlab/toolbox/NAG/mex.a64:$LD_LIBRARY_PATH
added to it. If you decide to modify your LD_LIBRARY_PATH by hand then a good approach is to edit the definition of LDPATH_PREFIX in the .matlab7rc file. The main reason that this is not the approach taken by the installation script is that MATLAB allows a user to over-ride the system-wide version with their own version(s) and so it is not possible reliably to install the toolbox for all users this way. The MATLAB documentation contains more information about the use of the .matlab7rc file.

4.2. Uninstalling the Software

To uninstall the software run the script UNINSTALL.a64 which is created during installation and can be found in the directory toolbox/NAG, using the command
 sh UNINSTALL.a64

4.3. License Management

The use of the NAG Toolbox is controlled by the Kusari network license management system. This release of the NAG Toolbox uses version 2.2-20 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.

To request a license key, run the program khostid located in /MyMatlab/toolbox/NAG/license/bin/linux/. This utility must be run from a command prompt. Return the information that it displays by e-mail (or FAX) to NAG.

A short term (demonstration or trial) license key contains one or more lines like the following:

MBL6A22DJL TRIAL 2009/11/12 "EMnxidA3oeoj0F1Yvi5ibxPjB7"
Specifically, it has a line containing the word TRIAL and is referred to here as an uncounted license key. Longer term uncounted 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. Other types of keys may also be issued.

Once you have obtained the license key, store the text of it in a file, say /MyMatlab/toolbox/NAG/license.lic.

For an uncounted license, the location of the license file must be made known to the NAG Toolbox by setting the environment variable NAG_KUSARI_FILE to the full pathname of the file before MATLAB is started.

For example, in the C-shell, type:

   setenv NAG_KUSARI_FILE /MyMatlab/toolbox/NAG/license.lic
or in the Bourne shell, type:
   NAG_KUSARI_FILE=/MyMatlab/toolbox/NAG/license.lic
   export NAG_KUSARI_FILE
No other actions are required to install an uncounted license.

To check that the license has been correctly installed, start MATLAB and type a00ac. If this returns 1 then the license has been installed successfully and a license is available.

Further details about Kusari and how it may be configured to suit your local circumstances can be found in /MyMatlab/toolbox/NAG/license/doc.

5. Documentation

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

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 a current 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 and NAG product code (in this case MBL6A22DJL).

(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/ or http://www.nag-j.co.jp/

(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
Japan
email: help@nag-j.co.jp

Tel: +81 (0)3 5542 6311
Fax: +81 (0)3 5542 6312