Jacket Installation

From Jacket Wiki

(Redirected from Installation and Activation)
Jump to: navigation, search
Back to Jacket Overview, Forward to Jacket Basics

Contents

Download

We recommend downloading the latest stable version of Jacket (download, see the release notes).

Installation

If you need any assistance with any of these steps, search the Download and Installation section of the AccelerEyes forums.

Meet Requirements

Jacket can be installed on Windows, Linux and Mac OS systems. Please make sure you satisfy all the requirements below:
Common Requirements:

  • MATLAB®
    • R2006B or later
    • What additional MATLAB add-ons do you need?
      • A single GPU at a time: no MATLAB add-ons required
      • Multiple GPUs on the same node: Parallel Computing Toolbox™ required
      • Multiple GPUs on multiple nodes, Parallel Computing Toolbox™ and Distributed Computing Server™ required.
  • Graphics Cards
    • One or more CUDA™-capable NVIDIA GPUs
    • Jacket runs on all CUDA-capable GPUs on laptops, desktops and servers.
    • Before installing Jacket, check if all your GPUs are CUDA-capable here.
    • Is your display connected to a non-NVIDIA card (such as motherboard display ports)? Read this article.
  • The latest NVIDIA Driver (download)
  • We recommend your CPU to have more memory than your GPU (read why)
  • AccelerEyes Account
    • To use Jacket, you need an account on the AccelerEyes website.
      • If you are trying to install a trial, create an account here.
      • If you have purchased Jacket, you should already have an account as an end-user. Use those credentials to log into your on-line account. Your purchased license will be visible after logging in, on the Manage Jacket tab on the left portion of your screen.


Windows-specific:
Jacket supports 32- and 64-bit versions of:

  1. Windows XP
  2. Windows Vista
  3. Windows 7
  4. Windows Server
  • For some Windows systems, you may need to install the Microsoft Visual C++ 2008 Redistributable Package (32-bit download and 64-bit download)
  • For some Windows systems, you may need to install the Microsoft .NET framework (download)
  • Note that Jacket over Remote Desktop is only supported for TCC-enabled GPUs (learn more).


If your system meets the Windows requirements, proceed to the steps for installation on Windows.


Linux-specific:
Jacket supports Linux (32 & 64 bit):

  • Fedora 10+, OpenSUSE 11+, RHEL 5.x, CentOS 5.x, SLES 10.2, and most other flavors of Linux work with Jacket.
  • Read through the following links if you have Ubuntu or Arch Linux


If your system meets the Linux requirements, proceed to the steps for installation on Linux.
Mac OS-specific:
Jacket supports 32‐bit and 64-bit Mac OSX. (64-bit requires OSX 10.6.3 or later)


If your system meets the Mac requirements, proceed to the steps for installation on Mac.

Install Jacket


Install Jacket on Windows

Install

Run the downloaded installer (an EXE file).

  • The default directory installation directory is C:/Program Files/AccelerEyes/Jacket.
  • The installer will detect older versions of Jacket and remove them automatically.
    • If it is unable to detect the older installation, use the "Add/Remove Programs" tool on your system or the provided uninstaller (in the Jacket directory).
Choose "Yes" to automatically activate Jacket
Enter your login credentials
Choose a currently active license


Activate automatically
On Windows, you can easily activate your copy of Jacket during installation. Choose 'Yes' when prompted by the installer to proceed with auto-activating Jacket. (See the images on the right).
This process downloads a license file , jlicense.dat, into the engine directory of Jacket.
Provide your log-in credentials.

  • Trial License:

Click on 'Generate Trial License'.

  • Purchased License:

After logging in you will be presented with a list of your valid licenses.
Licenses displayed in red are not eligible for usage with the current version of Jacket due to an expired maintenance date.
Select the license that you would like to use with your current machine and click 'OK'. You can visit your Manage Jacket Page for more information about the licenses you have available.

If this step does not work, try manual activation.
You are now ready to test your installation of Jacket!

Add the engine directory in MATLAB, as follows: 

addpath "C:/Program Files/AccelerEyes/Jacket/engine"

Alternatively, you can use the File -> Set Path functionality in the MATLAB GUI. WARNING: Do not choose Add with Subfolders or you may accidentally add the <jacket_root>/doc/ghelp directory to your path which will erroneously give GHELP functions precedence over the actual compute functions.

Also, for convenience sake, the "Start Jacket" option in the Start Menu starts MATLAB and automatically adds the appropriate Jacket paths.


If you have already activated your license, then you can test your installation.

Install Jacket on Linux

Note: To uninstall a previous version of Jacket, simply delete its installation directory.

Begin installation by running the *.run file that you downloaded. From a terminal shell prompt, do: 

sh Jacket-linux-<version>.run

The default installation directory is /usr/local/jacket.

Now, add the <jacket_root>/engine directory to the MATLAB path, as follows: 

addpath /usr/local/jacket/engine

Alternatively, you can use the File -> Set Path functionality in the MATLAB GUI. WARNING: Do not choose Add with Subfolders or you may accidentally add the <jacket_root>/doc/ghelp directory to your path which will erroneously give GHELP functions precedence over the actual compute functions.

Next, you need to manually activate this license by using GACTIVATE, as described below.

Install Jacket on Mac OS

Note: To uninstall a previous version of Jacket, simply delete its installation directory.

Mount the disk image and copy its contents to an appropriate place (e.g. /usr/local/jacket or /Applications/Jacket)

Add the engine directory in MATLAB, as follows: 

addpath /usr/local/jacket/engine

Alternatively, you can use the File -> Set Path functionality in the MATLAB GUI. WARNING: Do not choose Add with Subfolders or you may accidentally add the <jacket_root>/doc/ghelp directory to your path which will erroneously give GHELP functions precedence over the actual compute functions.

Next, you need to manually activate this license by using GACTIVATE, as described below.

Manual Activation

Note: This section discusses manual activation of Designated Computer Licenses, including all trial licenses. Concurrent Network Licenses are also available for purchase and involve separate activation steps. Also, you may want to review the available License Types.

If you are using Linux or Mac, or if you did not use the automated activation wizard included in the Windows installer, then the following instructions will explain how to manually activate Jacket.

Manual activation of a PURCHASED Designated Computer License requires the following steps:

  1. Run GACTIVATE - Run GACTIVATE to determine your Host ID (the MAC address of your network card).
  2. Generate & Download the License File - Use that Host ID to generate a jlicense.dat file on the Manage Licenses page.
  3. Put License in Engine - Copy the license file to the <jacket_root>/engine/ directory and run GACTIVATE once more to confirm Jacket is activated.

Manual activation of any TRIAL license requires the following steps:

  1. Generate & Download the License File - Generate a jlicense.dat file on the Manage Licenses page (no Host ID required).
  2. Put License in Engine - Copy this license file to the <jacket_root>/engine/ directory and run GACTIVATE to confirm Jacket is activated.

Run GACTIVATE

GACTIVATE is used to help manually activate Jacket licenses. The first time you run GACTIVATE you will see something like this: 

>> gactivate
Welcome to Jacket: The GPU Engine for MATLAB!
 
If this is a trial version of Jacket, place your trial
license file here: <jacket_root>/engine/jlicense.dat
 
If this is a purchased version of Jacket, select the Host
ID below of your most stable network interface. Then paste
the Host ID into the Manage Licenses page (https://www.accele
reyes.com/licenses) and download the license. Finally,
place the file here: <jacket_root>/engine/jlicense.dat
 
 Host ID 1 = 001122334455
 
To get more information about your network interfaces,
you can run the following in MATLAB:
 
  For Windows,      >> !ipconfig /all
  For Linux or Mac, >> !ifconfig
 
NO JACKET LICENSE FOUND OR LICENSE IS INVALID.
Place the jlicense.dat license file here, <jacket_root>/engine/jlicense.dat, and restart MATLAB.
For more information, visit http://wiki.accelereyes.com/wiki/index.php/Installation_and_Activation.

Generate & Download the License File

From the list of Host IDs, select one to register. We suggest choosing Host IDs corresponding to permanent interfaces, e.g. on laptops choose the wired ethernet card rather than wireless card. Using this Host ID, you then need to generate and download a jlicense.dat file from the Manage Licenses page. If you do not have an account yet, you can create an account.

In the Manage License page, you will find two sections,

  • Purchased Licenses
  • Trial Licenses

Purchased Licenses

In the purchased license section of the Manage License page, all purchased licenses are listed. The list will be empty if you have not yet purchased.

The license fields include:

  • License Number
  • Purchase Date
  • Maintenance Expiration – licenses are only available for Jacket versions released before this date
  • Support Expiration – the expiration date of phone support for this license
  • Custom Label – choose a custom label for your license (optional)
  • Features – all addon features associated with this license
  • Host ID – the Host ID to which this license is bound
  • License Download – The link to download jlicense.dat for valid licenses

Note, in following figure, we show three states in which licenses may exist:

  • License #110000413 shows "Too Many Activations" indicating that this license must be activated by phone to AccelerEyes’ Support.
  • License #110000415 shows "Not Available for 1.2.2" since the Maintenance expired before 1.2.2 was released.
  • License #110000417 is active and available. It already has a generated license file that is downloadable from the provided link.
  • License #110989648 is active and available. It has not yet been activated and needs a Host ID to be submitted to generate the downloadable license file.
To activate a license, simply copy the Host ID into the website and click "Submit Host Information". After doing this, a "Download License" link will appear from which you can download the jlicense.dat file.
LicenseList.png

Trial Licenses

You can generate a trial license in 2 simple steps.

  1. Press the "Start Trial" button:
    BeginTrial.png
  2. The trial license should be generated immediately. It can be downloaded using the download link:
    GetTrial.png

Put License in Engine

Once you have generated your license file, place this in the <jacket_root>/engine directory and activation is complete.

Note that for Linux and Mac systems, if you are unable to write jlicense.dat to the <jacket_root>/engine/ directory, environment variables can be set to point to the license file in a different location. For example, suppose the license is at /home/john_smith/jlicense.dat, then either of the following can be used: 

export LM_LICENSE_FILE=/home/john_smith/jlicense.dat
export LM_LICENSE_PATH=/home/john_smith

You can verify Jacket is properly activated by re-running GACTIVATE and looking for the following output: 

>> gactivate
Welcome to Jacket: The GPU Engine for MATLAB!
 
Running diagnostic tests:
  Checking Jacket runtime by running GINFO...
 
Jacket v1.4.0 (build XXXX) by AccelerEyes
License Type: Designated Computer (on 32-bit Linux)
Licensed Addons: SDK, DLA, JMC
Multi-GPU: Licensed for 4 GPUs
 
Detected CUDA-capable GPUs:
CUDA driver 256.35, CUDA toolkit 3.1
GPU0 Tesla C1060, 1666 MHz, 4096 MB VRAM, Compute 1.3 (single,double) (in use)
GPU1 GeForce 8400 GS, 932 MHz, 512 MB VRAM, Compute 1.1 (single)
 
GPU Memory Usage: 4058 MB free (4096 MB total)
 
  Checking Jacket runtime (continued)...                  PASSED
 
CONGRATULATIONS, JACKET IS ACTIVE AND READY TO USE!
 
****
Note, if you need to upgrade from a trial license to a
purchased license, select the Host ID below of your most
stable network interface. Then paste the Host ID into the
Manage Licenses page (https://www.accelereyes.com/licenses)
and download the license. Finally, place the file here:
<jacket_root>/engine/jlicense.dat
 
 Host ID 1 = 001122334455
 
To get more information about your network interfaces,
you can run the following in MATLAB:
 
  For Windows,      >> !ipconfig /all
  For Linux or Mac, >> !ifconfig

Test Installation & Activation

After Jacket has been activated, you can use the GINFO function to verify the installation and configuration of the GPU hardware in your machine. If your computer has multiple GPUs and you wish to use a different GPU than the one automatically selected by Jacket, you can use the GSELECT function.

If you encounter errors, please double check the system requirements or visit the FAQ. To ask questions, visit the forums.

You can also try simple computations to make sure things are working, such as: 

A = grand(3)
fft(A)

If you notice a brief pause prior to this first computation, don't be alarmed. It takes a moment to "warm up" the GPU for ensuing computations! 

Continue to Jacket Basics
Retrieved from "http://wiki.accelereyes.com/wiki/index.php/Jacket_Installation"
Personal tools