You copied the Doc URL to your clipboard.

2 Installation

A release of Arm Performance Reports can be downloaded from the Arm Developer website.

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

2.1 Linux installation

2.1.1 Graphical install

Untar the package and run the installer executable, using:


   tar xf arm-reports-18.1.3-<distro>-<arch>.tar 
cd arm-reports-18.1.3-<distro>-<arch>
./installer

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-reports-18.1.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 allows you to choose which user(s) to install Arm Performance Reports for.

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

PIC

Figure 1: Arm Performance Reports Installer-Installation type

Once you have selected the installation type, you are prompted to specify the directory you would like to install Arm Performance Reports 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.

PIC

Figure 2: Arm Performance Reports Installer-Installation directory

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

PIC

Figure 3: Install in progress

Arm Performance Reports does not have a GUI and does not add any desktop icons.

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 large number of different site configurations and MPI distributions that are supported by Arm Performance Reports, it is inevitable that you may need to take further 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 textinstall.sh is useful if you are installing remotely.

To install using the text-mode install script, untar the package and run the textinstall.sh script, using:


   tar xf arm-reports-18.1.3-<distro>-<arch>.tar 
cd arm-reports-18.1.3-<distro>-<arch>
./text-install.sh

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-reports-18.1.3-Redhat-7.4-aarch64.tar

Next, you are prompted with the license agreement. To read the license, press Return. Following the license prompt, you are requested to enter the directory where you want to install Arm Performance Reports. This directory must be accessible on all the nodes in your cluster. Enter a directory for the installation.

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

    ./textinstall.sh --accept-licence <installation_directory>

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

2.2 License files

Arm Performance Reports requires a license file for its operation.

Time-limited evaluation licenses are available from the Arm Developer website.

2.3 Workstation and evaluation licenses

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

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


   export ALLINEA_LICENCE_DIR=${HOME}/SomeOtherLicenceDir
ALLINEA_LICENSE_DIR is an alias for ALLINEA_LICENCE_DIR.

2.4 Supercomputing and other floating licenses

Licensing!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 Performance Reports.

The Arm Licence Server and instructions for its installation and usage may be downloaded from the 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 name Licence.xxxx, and a client license file Licence.

The client file should be copied to {installation-directory}/licences, for example, /home/user/arm/reports/licences/Licence.

You 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.5 Architecture licensing

Licenses issued after the release of Arm Performance Reports 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

2.5.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
Was this page helpful? Yes No