Attune Installation Instructions

Attune

Installation
------------------------
------------------------

Platform requirements
------------------------
Attune supports Windows and Linux platforms.  Attune requires Matlab version 8.5
or later and Python version 2.2.3 or later (for compatibility with ABAQUS -- Python
is not required for use with Nastran).  Python is included with the distribution of 
ABAQUS.  You can find the latest version of Python as well as Python documentation 
at http://www.python.org.  

Installing the license
------------------------

Attune uses a client-server licensing scheme. As a result, the license server, 
called Sentinel RMS, needs to be installed and configured separately. Sentinel RMS is 
a robust, commercial client/server-based licensing system from SafeNet that can 
simultaneously serve multiple licenses for multiple software products. The server 
typically resides on a central computer. The client software, such as Attune, will 
reside on computers that will be utilizing the software. The client computer may or 
may not be the same as the license server. The client can also be on a different 
software platform than the server.

Sentinel RMS installation is straightforward. Detailed installation instructions are 
shipped with the Sentinel RMS package available on ATA’s website. This section 
highlights the basics of the installation process.

Installing Sentinel RMS:

On Windows, the Sentinel RMS package is an InstallShield application. As such, it must 
be installed by someone with administrator privileges. ATA recommends that the default 
selections be used during the installation.

On Unix/Linux, the Sentinel RMS package is a gzipped tar file. Extracting this file will 
create an rms directory with several files. Sentinel RMS does not need to be installed 
or run as root, but root privileges are needed in order to install it so that it 
automatically starts when the server boots. The Sentinel RMS documentation provides 
details about the setup process.

Environment Variable:

All Sentinel RMS clients need a way to determine where the server is running. This is 
accomplished through an environment variable called LSHOST. Set the environment variable 
to the hostname of the server, separated by a tilde. The server name must be prepended by 
the name "no-net." For example, set it to

    no-net~server

where server is the name of the license server.

On Windows, the environment variable can be set in Control Panel, typically in System. 
On Unix/Linux you can set the environment variable with setenv or by using export, 
depending on your shell. Please ask your system administrator or refer to your operating 
system documentation for more details on how to set environment variables.

Checking Your License Status:

You can use the licstatus application included in the LIC directory to check the status 
of the licenses. When the GUI opens, click on "Refresh." The license server(s) will appear 
under "Defined Servers" at the top left of the form. Under each license server, the 
individual licenses will be listed. Clicking on a license will display statistics about 
that license, including who is using it and how many licenses are available.


Installing Attune
------------------------

Starting in v2.0.2, there are two different versions of Attune. There is the version that
requires MATLAB, and a new standalone version that just requires the MATLAB Compiler Runtime
files. Below are the instructions for installing either version.

Using the Attune Installer to Install Attune for MATLAB

Starting with Attune v1.2.0, Attune can be installed with a standalone installer. This 
installer prompts for an installation directory and automatically installs Attune into 
that location. At the end of the installation, the installer will automatically add 
Attune to the MATLABPATH. Any other instances of Attune that are in this file will be 
commented out. For reference, the MATLABPATH is stored in /toolbox/local/pathdef.m in 
the MATLAB root directory. A back-up copy of the path file will be made with the *.bak 
extension after the change is complete.

You can opt out of this and manually add Attune to your MATLABPATH by unchecking the 
"Add Attune to MATLAB's Path" option at the end of the installation. Instructions for 
manually adding Attune to your path are included below.

If you install Attune into MATLAB’s toolbox directory, and you are using the toolbox 
path cache, you will need to update it. You can do this in MATLAB in File, Preferences. 
Under the General section at the top of the form, there is a section titled, 
"Toolbox path caching." Simply click on the button that says, "Update Toolbox Path Cache." 
Alternately, you can also disable the toolbox path cache by unchecking the box labeled, 
"Enable toolbox path cache."

Manually Putting Attune in Your Path (setting your MATLABPATH):

To use Attune, you must arrange for the Attune directory to be in your MATLAB search path. 
This can be done by an individual user, or it can be set up by the system administrator 
for all MATLAB users. Two methods for setting up the path are given below, and experienced 
MATLAB users will know of other ways. (In the following instructions, %MATLAB% refers to 
your top-level MATLAB directory, and %ATTUNE_INSTL% refers to your top-level directory 
where Attune is installed.)

Option 1 (does not require sysadmin):

1.  Create a file called startup.m (or edit an existing one). Put the following command in 
    this file:
        addpath %ATTUNE_INSTL% -end
    (but use the actual path in place of %ATTUNE_INSTL%). This will add Attune to the end 
    of your MATLAB path.

Option 2 (requires sysadmin):

1.  Edit the file %MATLAB%\toolbox\local\matlabrc.m and insert the following command in 
    this file (after the default path is set):
        addpath %ATTUNE_INSTL% -end
    (but use the actual path in place of %ATTUNE_INSTL%). This will add Attune to the end 
    of the MATLAB path for all users. This change will need to be repeated if you update 
    or reinstall MATLAB.

Option 3 (recommended; requires sysadmin):

1.  Edit the file %MATLAB%\toolbox\local\pathdef.m and insert a line for the Attune 
    directory. The new file will look something like this:
        function p = pathdef
        <lines omitted...>
        % PATH DEFINED HERE -- Don't change this line.
        p = [...
            '$toolbox\matlab\general:',
            <lines omitted...>
            '$toolbox\matlab\demos:',...
            '$toolbox\local:',...
            '$toolbox\tour',...
            '%ATTUNE_INSTL%:',...
            ...
            ];
        p = [userpath,p];

2.  Use the actual path name (e.g., C:\matlab\toolbox) for %ATTUNE_INSTL%. 
    NOTE: A disadvantage of this method is that any MATLAB upgrade or new installation will 
    overwrite this file, so the change will need to be repeated.

Using the Attune Installer to Install Standalone Attune:

Starting with Attune v2.0.2, a version of Attune can be installed which does not require MATLAB.
Like the MATLAB version, this version is also installed with a standalone installer. The installer 
prompts for an installation directory and automatically installs Attune into that location. 
Attune can then be launched by selecting the Attune icon from the Start Menu.

This version requires that the MATLAB Compiler Runtime (MCR) be installed. The installer for these 
files is available from the ATA website (www.ata-e.com)