About this Install Guide

This guide is intended to get you up and running with this tool quickly with the most common settings. For a thorough review of all options, refer to the official documentation.

The Arm Performance Libraries provide developers with optimized math libraries for high performance computing applications on Arm Neoverse based hardware.

These libraries include highly optimized functions for BLAS, LAPACK, FFT, sparse linear algebra, libamath and libastring. These libraries are free to use and do not require a license. They can be installed either standalone or with your installation of Arm Compiler for Linux . This install guide covers the standalone installation.

Arm Performance Libraries are available for use on Windows 11 on Arm , macOS (Apple Silicon), and Linux (AArch64) hosts.

Windows

On your Windows 11 Arm machine, go to the Arm Performance Libraries download page . Click on the Download Windows section. You will be prompted to review and accept the End User License Agreement before you can download the zip file. Click on the I accept the terms of this License Agreement checkbox and proceed to Download as shown below.

Image Alt Text: win_download

Open your Windows File Explorer and locate the downloaded arm-performance-libraries_23.08.zip file. Extract the contents of this zip file using the “Extract all” button at the top of the Windows File Explorer.

Update your system environment variables

Using Windows Search, open Edit the System Variables in the Control Panel. On the Advanced Tab of the System Properties window, click on the Environment Variables button.

Image Alt Text: sys_prop

Add a New variable called ARMPL_DIR which should point to the location where you unpacked the Arm Performance Libraries.

Image Alt Text: add_var

Edit the Path variable to add %ARMPL_DIR%\bin to the list of existing directories in your path.

Image Alt Text: edit_path

You can now start linking your application to the Arm Performance libraries on your Windows on Arm device. Follow the examples in the included RELEASE_NOTES file of your extracted installation directory to get started.

macOS

Go to the Download MacOS section of the Arm Performance Libraries download page and download the dmg file. Double-click on the icon of the downloaded package to mount the disk image. Alternatively, open a terminal and run the command below:

    

        
        
            hdiutil attach armpl_23.06_flang-new_clang_16.dmg
        
    

Now run the installation script as a superuser:

    

        
        
            /Volumes/armpl_23.06_flang-new_clang_16_installer/armpl_23.06_flang-new_clang_16_install.sh -y 
        
    

Using this command you automatically accept the End User License Agreement and the packages are installed to the /opt/arm directory. If you want to change the installation directory location use the --install_dir option with the script and provide the desired directory location.

To get started, compile and test the examples included in the /opt/arm/<armpl_dir>/examples/, or <install_dir>/<armpl_dir>/examples/ directory, if you have installed to a different location than the default.

Linux

Arm Performance Libraries are supported on most Linux Distributions like Ubuntu, RHEL, SLES and Amazon Linux on an AArch64 host and compatible with various versions of GCC.

Download the appropriate package for your Linux distribution and version of GCC from the Download Linux section.

The instructions shown below are for an Ubuntu 22.04 AArch64 Linux Host with GCC version 11.3 installed.

On a terminal, run the command shown below to download the appropriate package:

    

        
        
            wget https://developer.arm.com/-/media/Files/downloads/hpc/arm-performance-libraries/23-04-1/ubuntu-22/arm-performance-libraries_23.04.1_Ubuntu-22.04_gcc-11.3.tar
        
    

Use tar to extract the file and then change directory:

    

        
        
            tar -xf arm-performance-libraries_23.04.1_Ubuntu-22.04_gcc-11.3.tar
cd arm-performance-libraries_23.04.1_Ubuntu-22.04/
        
    

Run the installation script as a super user:

    

        
        
            sudo ./arm-performance-libraries_23.04.1_Ubuntu-22.04.sh -a
        
    

Using the -a switch you automatically accept the End User License Agreement and the packages are installed to the /opt/arm directory. If you want to change the installation directory location use the --install-to option with the script and provide the desired directory location.

Setup your environment

Install environment modules on your machine:

    

        
        
            sudo apt install environment-modules
        
    

Set the MODULEPATH environment variable to point to the location of the installed modulefiles for Arm Performance Libraries:

    

        
        
            export MODULEPATH=$MODULEPATH:/opt/arm/modulefiles
        
    

List the available modules:

    

        
        
            module avail
        
    

The output should be similar to:

    

        
        armpl/23.04.1_gcc-11.3

        
    

Load the appropriate module:

    

        
        
            module load armpl/23.04.1_gcc-11.3
        
    

You can now compile and test the examples included in the /opt/arm/<armpl_dir>/examples/, or <install_dir>/<armpl_dir>/examples/ directory, if you have installed to a different location than the default.


Feedback

How would you rate the overall quality of this tool quick-install guide?