You copied the Doc URL to your clipboard.

2 Installation

A release of Arm Forge, containing Arm DDT and Arm MAP may be downloaded from the Arm Developer website.

Both a graphical and text-based installer are provided. See the following sections for further details.

2.1 Linux installation

2.1.1 Graphical install

Untar the package and run the installer executable using these commands:

   tar xf arm-forge-19.0.3-<distro>-<arch>.tar 
cd arm-forge-19.0.3-<distro>-<arch>

replacing <distro> and <arch> with the OS distribution and architecture of your tar package, respectively. For example, the tarball package for Redhat 7.4 OS and Armv8-A (AArch64) architecture is: arm-forge-19.0.3-Redhat-7.4-aarch64.tar

The installer consists of a number of pages where you can choose install options. Use the Next and Back buttons to move between pages or Cancel to cancel the installation.

The Install Type page lets you choose which user(s) to install Arm Forge for.

If you are an administrator (root) you may install Arm Forge for All Users in a common directory such as /opt or /usr/local, otherwise only the Just For Me option is enabled.


Figure 1: Installer-Installation type

Once you have selected the installation type, you are prompted to specify the directory you would like to install Arm Forge in. For a cluster installation, choose a directory that is shared between the cluster login or frontend node and the compute nodes. Alternatively, install it on or copy it to the same location on each node.


Figure 2: Installer-Installation directory

You are shown the progress of the installation on the Install page.


Figure 3: Install in progress

Icons for DDT and MAP will be added to your desktop environment's Development menu.

It is important to follow the instructions in the README file that is contained in the tar file. In particular, you need a valid license file. Use the following link to obtain an evaluation license: Get software.

Due to the vast number of different site configurations and MPI distributions that are supported by Arm Forge, it is inevitable that sometimes you may need to take additional steps to get everything fully integrated into your environment. For example, it may be necessary to ensure that environment variables are propagated to remote nodes, and ensure that the tool libraries and executables are available on the remote nodes.

2.1.2 Text-mode install

The text-mode install script is useful if you are installing remotely. This can be used as follows:

   tar xf arm-forge-19.0.3-<distro>-<arch>.tar 
cd arm-forge-19.0.3-<distro>-<arch>

replacing <distro> and <arch> with the OS distribution and architecture of your tar package, respectively. For example, the tarball package for Redhat 7.4 OS and Armv8-A (AArch64) architecture is: arm-forge-19.0.3-Redhat-7.4-aarch64.tar

Press Return to read the license when prompted and then input the directory where you would like to install Arm Forge. The directory must be accessible on all the nodes in your cluster.

Alternatively, to run the text-mode install script, accept the license, and point to an installation directory in one step, pass the arguments --accept-licence and <installation_directory> when executing For example:

    ./ --accept-licence <installation_directory>

replacing the <installation_directory> with a directory of your choice.

2.2 Mac installation

The Arm Forge client for Mac OS X is supplied as an Apple Disk Image (*.dmg) file. This includes the documentation folder, which contains a copy of this user guide and the release notes. It also contains the Arm Forge client application bundle icon, which should be drag and dropped into the Applications directory.


Figure 4: Mac Installer-Installation Folder

2.3 Windows installation

The Arm Forge client for Windows is installed using a graphical installer. This is a familiar Windows set-up executable, although care needs to be taken with the choice of a destination folder for the installation.


Figure 5: Windows Installer-Installation Folder

If the user performing the installation has administrative rights, then the default installation folder is C:\Program Files\Arm Forge. If administrative rights have not been granted, then the default is C:\Users\<user>\AppData\Local.

2.4 License files

Arm Forge products require a license file for their operation. If you are using the Remote Client you do not need a license file on the machine running the Remote Client, but on the machine you are connecting to instead.

If you do not have a license file, the GUI will show this in the lower-left corner and you will not be able to run, debug or profile new programs.

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

2.5 Workstation and evaluation licenses

Workstation and Evaluation license files for Arm Forge do not require Arm Licence Server and should be copied directly to {installation-directory}/licences. For example, /home/user/arm/forge/licences/Licence.ddt. Do not edit the files as this will prevent them from working.

If you have separate license files for Arm DDT and Arm MAP you do not need separate installations of Arm Forge. You may instead copy the individual license files to {installation-directory}/licences. When Arm Forge is started you may choose between Arm DDT and Arm MAP on the Welcome page. If you have multiple licenses for the same product the license with the most tokens is preferred.

You may specify an alternative location of the license directory using the environment variable ALLINEA_LICENCE_DIR. For example:

   export ALLINEA_LICENCE_DIR=${HOME}/SomeOtherLicenceDir

2.6 Supercomputing and other floating licenses

For users with Supercomputing and other floating licenses, the Arm Licence Server must be running on the designated license server machine prior to running Arm Forge.

The Arm Licence Server and instructions for its installation and usage may be downloaded from Arm Developer website.

The license server download is on the Arm Forge download page.

A floating license consists of two files: the server license (a file named Licence.xxxx) and a client license file named Licence. The client file should be copied to {installation-directory}/licences. For example, /home/user/arm/forge/licences/Licence. You will need to edit the hostname line to contain the host name or IP address of the machine running the Licence Server. See the Licence Server user guide for instructions on how to install the server license.

2.7 Architecture licensing

Licenses issued after the release of Arm Forge 6.1 specify the compute node architectures that they may be used with. Licenses issued prior to this release will enable the x86_64 architecture by default. Existing users for other architectures will be supplied with new licenses that will enable their architectures.

If there is any problem then contact Arm support at Arm support.

2.7.1 Using multiple architecture licenses

If you are using multiple license files to specify multiple architectures, it is recommended that you leave the default licenses directory empty. Instead, create a directory for each architecture, and when you target a specific architecture set ALLINEA_LICENSE_DIR to the relevant directory. Alternatively, you can set ALLINEA_LICENSE_FILE in order to specify the license file.

By way of example, consider a site where there are two target architectures, x86_64 and aarch64. Create two directories, licenses_x86_64 and licenses_aarch64. Then, if you want to target aarch64, you would set the license directory as follows:

   export ALLINEA_LICENSE_DIR=/path/to/licenses_aarch64