You copied the Doc URL to your clipboard.

2 Installation

The following sections describe how to install Arm Forge on Linux, Windows and Mac operating systems, and include details about the available licensing options.

2.1 Linux graphical install

Procedure
  1. Download the required package from the Arm Developer website: Arm downloads.
  2. Untar the Arm Forge installation package and run the installer executable by using these commands:

    tar xf arm-*(forge)*-*(19.1.3)*-<distro>-<arch>.tar
    cd arm-*(forge)*-*(19.1.3)*-<distro>-<arch>
    ./installer


    Note: Replace <distro> and <arch> with the required OS distribution and architecture. For example, the tarball package for Redhat 7.4 OS and Armv8-A (AArch64) architecture is:
    arm-forge-19.1.3-Redhat-7.4-aarch64.tar
  3. Use the Next and Back buttons to move between the installer pages to specify the installation options.
    Click Cancel to cancel the installation.
  4. On the Install Type page, specify for which users to install Arm Forge.

    Note: If you are an administrator (root), you can install Arm Forge for All Users in a common directory such as /opt or /usr/local. Otherwise, the Just For Me option is selected, by default.

    PIC

    Figure 1: Installer-Install type
  5. After you select the installation type, enter the directory where you want to install Arm Forge.

    Note: For a cluster installation, choose a directory that is shared between the cluster login or frontend node, and the compute nodes. Alternatively, install or copy Arm Forge into the same location on each node.

    PIC

    Figure 2: Installer-Destination
  6. The progress of the installation displays on the Install page.

    PIC

    Figure 3: Install in progress
Results

The installation adds icons for DDT and MAP to the Development menu in your desktop environment.
After the installation is complete, read the instructions in the RELEASE-NOTES file in the install package, for details about how to run Arm DDT and Arm MAP.

Next steps

You can obtain an evaluation license at the following link: Get software.

Arm Forge supports a large number of different site configurations and MPI distributions, therefore you must ensure that you fully integrate all components into your environment. For example, propagate environment variables to remote nodes, and ensure that the tool libraries and executables are available on the remote nodes.

Related information
  • Alternatively, use the Linux text-mode install to perform the installation.
  • License files
  • Chapter 5 provides details about getting started with Arm DDT.
  • Chapter 16 provides details about getting started with Arm MAP.

2.2 Linux text-mode install

Install Arm Forge remotely using the textinstall.sh text-mode install script.

Procedure
  1. Download the required package from the Arm Developer website: Arm downloads.
  2. Untar the Arm Forge installation package and run the textinstall.sh script by using these commands:

    tar xf arm-*(forge)*-*(19.1.3)*-<distro>-<arch>.tar
    cd arm-*(forge)*-*(19.1.3)*-<distro>-<arch>
    ./textinstall.sh


    Note: Replace <distro> and <arch> with the required OS distribution and architecture. For example, the tarball package for Redhat 7.4 OS and Armv8-A (AArch64) architecture is:
    arm-forge-19.1.3-Redhat-7.4-aarch64.tar
  3. When you are prompted, press Return to read the license, and then enter the path of the Arm Forge installation directory. The directory must be accessible on all the nodes in your cluster.
Related information
  • Alternatively, use the Linux graphical install to use the graphical installer.
  • License files
  • Chapter 5 provides details about getting started with Arm DDT.
  • Chapter 16 provides details about getting started with Arm MAP.

2.3 Mac installation

The Arm Forge client for Mac OS X is supplied as an Apple Disk Image (*.dmg) file. The DMG file includes the Documentation folder and the Arm Forge client application bundle icon. The Documentation folder contains a copy of this user guide and the release notes.

You do not need to install a license file on a machine running Remote Client for connecting remotely to Arm Forge products.

Procedure
  1. Download the required package from the Arm Developer website: Arm downloads.
  2. Drag and drop the Arm Forge client application bundle icon into the Applications directory.

    PIC

    Figure 4: Mac Installer-Installation Folder
Related information
  • Chapter 5 provides details about getting started with Arm DDT.
  • Chapter 16 provides details about getting started with Arm MAP.

2.4 Windows installation

The Arm Forge remote client for Windows is supplied as a Windows executable file.

You do not need to install a license file on a machine running Remote Client for connecting remotely to Arm Forge products.

Procedure
  1. Download the Windows remote client package from the Arm Developer website: Arm downloads.
  2. Run the Windows file executable to install Arm Forge using a graphical installer.
  3. When prompted, input the directory where you want to install Arm Forge.

    PIC

    Figure 5: Windows Installer-Installation Folder

    Note: If you have administrative rights for installation, then the default installation folder is C:\Program Files\Arm Forge.
    If you do not have administrative rights, then the default is C:\Users\<user>\AppData\Local.

Related information
  • Chapter 5 provides details about getting started with Arm DDT.
  • Chapter 16 provides details about getting started with Arm MAP.

2.5 License files

You must install a license file on a machine running Arm Forge products. You do not need to install a license file on a machine running Remote Client for connecting remotely to Arm Forge products.

If you do not have a valid license file, the Arm Forge GUI shows an alert in the lower-left corner, and you can not run, debug or profile new programs.

Time-limited evaluation licenses are available from the Arm website: Get software.

2.6 Workstation and evaluation licenses

Workstation and evaluation license files for Arm Forge do not require Arm Licence Server.

Arm Forge supports separate license files for Arm DDT and Arm MAP with a single installation of Arm Forge.

If there are multiple licenses installed for the same product, Arm Forge uses the license with the most tokens.

Caution: Do not edit license files because this prevents them from working.

Procedure
  1. Copy your license files directly to <installation-directory>/licences. For example:
    /home/user/arm/forge/licences/Licence.ddt
  2. When Arm Forge starts, select Arm DDT or Arm MAP on the Welcome page.

If you would prefer to store the license files in an alternative location, use the environment variable ALLINEA_LICENCE_DIR to specify it. For example:


   export ALLINEA_LICENCE_DIR=${HOME}/SomeOtherLicenceDir

Note: ALLINEA_LICENSE_DIR is an alias for ALLINEA_LICENCE_DIR.

Related information

2.7 Supercomputing and other floating licenses

If you are using floating licenses for an HPC cluster, you need to use Arm Licence Server. Download the required package from the Arm Forge downloads page on the Arm Developer website: Arm downloads.

A floating license consists of two files: the server license (a file named Licence.xxxx) and a client license file named Licence.

You can find more information about Arm Licence Server on the Arm Licence Server website.

Procedure
  1. Copy the client file (Licence) to {installation-directory}/licences.
    For example, /home/user/arm/forge/licences/Licence.
  2. Edit the hostname line to contain the host name or IP address of the machine running the Licence Server.
  3. See the Licence Server user guide on the Arm Licence Server website for instructions on how to install the server license.
  4. Ensure that Arm Licence Server is running on the designated license server machine before you run Arm Forge.
Related information

2.8 Architecture licensing

Licenses issued after the release of Arm Forge 6.1 specify the compute node architectures with which they can be used. Licenses issued before this release enable the x86_64 architecture by default. If you are using another architecture, you will receive a new license to enable your architecture.

Visit Arm support to contact the support team if you have any problems with your license.

2.8.1 Using multiple architecture licenses

If you are using multiple license files to specify multiple architectures, Arm recommends that you follow these steps.

Procedure
  1. Ensure that the default licenses directory is empty.
  2. Create a directory for each architecture.
  3. When you want to target a specific architecture, set ALLINEA_LICENSE_DIR to the relevant directory.
    Alternatively, set ALLINEA_LICENSE_FILE to specify the license file.
Example

On a site that targets two architectures, x86_64 and AArch64, create a directory for each architecture, and name them licenses_x86_64 and licenses_aarch64. Then, to target the architectures, set the license directories as follows:

To target AArch64:


export ALLINEA_LICENSE_DIR=/path/to/licenses/licenses_aarch64

To target x86_64:


export ALLINEA_LICENSE_DIR=/path/to/licenses/licenses_x86_64
Was this page helpful? Yes No