Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions content/install-guides/aws-sam-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ weight: 1

The Amazon Web Services (AWS) Serverless Application Model (SAM) CLI is an open-source command-line tool that you can use to build, test, and deploy serverless applications. The SAM CLI provides a Lambda-like execution environment that lets you locally build, test and debug applications defined by AWS SAM templates. It is available for a variety of operating systems and Linux distributions, and supports the Arm architecture.

## Before you begin
## How do I prepare to install the AWS SAM CLI on Ubuntu?

Follow the instructions below to install and try the latest version of the AWS SAM CLI for Ubuntu on Arm.

Expand Down Expand Up @@ -48,14 +48,14 @@ To install, run the following command:
sudo apt install python-is-python3 python3-pip -y
```

## Download and install the AWS SAM CLI
## How do I download and install the AWS SAM CLI?

There are two options to install the SAM CLI, you can select your preferred method:

* From a zip file.
* Using the Python `pip` command.

### Download and install from zip file
### How do I download and install from a zip file?

Use `wget`:

Expand All @@ -65,7 +65,7 @@ unzip aws-sam-cli-linux-arm64.zip -d sam-install
sudo ./sam-install/install
```

### Install the SAM CLI using Python pip
### How do I install the AWS SAM CLI using Python pip?

```
sudo apt install python3-venv -y
Expand All @@ -74,7 +74,7 @@ source .venv/bin/activate
pip install aws-sam-cli
```

### Confirm that the SAM CLI has been installed
### How can I confirm that the AWS SAM CLI was installed correctly?

```bash
sam --version
Expand All @@ -86,7 +86,7 @@ The version should be printed on screen:
SAM CLI, version 1.125.0
```

## Example application
## How do I create an example application with the AWS SAM CLI?

You can use the AWS SAM CLI to build and deploy a simple "Hello World" serverless application that includes the line `uname -m` to check the platform it is running on, by following these steps.

Expand Down Expand Up @@ -173,5 +173,5 @@ REPORT RequestId: 513dbd6f-7fc0-4212-ae13-a9a4ce2f21f4 Init Duration: 0.26 ms Du
{"statusCode": 200, "body": "{\"message\": \"aarch64\\n\"}"}
```

You are ready to use the AWS SAM CLI to build more complex functions and deploy them into AWS. Make sure to select `arm64` as the architecture for your Lambda functions.
You are ready to use the AWS SAM CLI to build more complex functions and deploy them into AWS. Make sure to select `arm64` as the architecture for your Lambda functions.

2 changes: 1 addition & 1 deletion content/install-guides/aws_access_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Copy the `Access key ID` and `Secret access key`
![aws3 #center](https://github.com/ArmDeveloperEcosystem/arm-learning-paths/assets/40816837/699c3643-f979-4548-81f9-4300828b6a06 "Copy keys")


## Configure the AWS CLI
## How do I configure the AWS CLI?

Run the following command to set up your AWS CLI:

Expand Down
6 changes: 3 additions & 3 deletions content/install-guides/azure-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ weight: 1

It is available for a variety of operating systems and Linux distributions and has multiple ways to install it.

## Before you begin
## How do I prepare to install the Azure CLI on Ubuntu?

[General installation information](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt) is available which covers all supported Linux distributions. Starting with version 2.46.0, Azure CLI supports Arm64 Linux distributions. The 'apt' package manager contains both x86_64 and Arm64 packages for the following linux distributions

```output
Ubuntu 20.04, Ubuntu 22.04, Ubuntu 24.04
```

## Install via Azure CLI script
## How do I install the Azure CLI using the installation script?

Confirm you are using an Arm machine by running:

Expand Down Expand Up @@ -69,7 +69,7 @@ You should see an output similar to below

If you prefer installing the Azure CLI using Python3, follow the instructions below.

## Download and Install using pip
## How do I download and install the Azure CLI using pip?

Another way to install Azure CLI for Ubuntu on Arm is to use Python pip.

Expand Down
4 changes: 2 additions & 2 deletions content/install-guides/azure_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar

In this section you will learn how to authenticate to the Azure environment using the Azure CLI. After log in, the CLI allows you to query and interact with Azure cloud resources.

## Before you begin
## How do I prepare to authenticate using the Azure CLI?

Install the Azure CLI on your machine using the [install guide](/install-guides/azure-cli/).

## Sign in interactively
## How do I sign in interactively to Azure?

Run the following command to initiate the log in:

Expand Down
24 changes: 12 additions & 12 deletions content/install-guides/forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ Linaro Forge consists of
* [Linaro MAP](https://www.linaroforge.com/linaro-map/) for performance profiling and optimization advice, and
* [Linaro Performance Reports](https://www.linaroforge.com/linaro-performance-reports/) for summarizing and characterizing both scalar and MPI application performance.

## Supported platforms
## What platforms are supported by Linaro Forge?

Linaro Forge runs on Linux hosts and multiple architectures. See the Linaro Forge [documentation](https://docs.linaroforge.com/latest/html/forge/supported_platforms/reference_table.html) for a full list of supported configurations.

This install guide assumes an Arm AArch64 platform running Ubuntu Linux.

## Download
## How do I download Linaro Forge?

Download and extract the appropriate installation package from [Linaro Forge Downloads](https://www.linaroforge.com/downloadForge/).

Expand All @@ -43,9 +43,9 @@ wget https://downloads.linaroforge.com/24.0.3/linaro-forge-24.0.3-linux-aarch64.
tar -xf linaro-forge-24.0.3-linux-aarch64.tar
```

## Installation
## How do I install Linaro Forge?

### Linux host
### How do I install Linaro Forge on a Linux host?

Run the installer from the command line with:

Expand All @@ -61,15 +61,15 @@ To install to the default directory, non-interactively:
linaro-forge-24.0.3-linux-aarch64/textinstall.sh --accept-license /home/ubuntu/linaro/forge/24.0.3
```

### Install on macOS (remote client only)
### How do I install Linaro Forge on macOS (remote client only)?

Drag and drop the client application bundle icon into the Applications directory.

### Install on Windows (remote client only)
### How do I install Linaro Forge on Windows (remote client only)?

Run the Windows file executable to install the Linaro Forge Remote Client.

### Graphical installer
### How do I run the graphical installer for Linaro Forge?

Optionally, you can run the installer executable with a graphical interface.

Expand All @@ -78,7 +78,7 @@ cd linaro-forge-24.0.3-linux-aarch64/
./installer
```

## Setting up the product license
## How do I set up the product license for Linaro Forge?

You must install a license file on a machine running Linaro Forge tools to debug or profile.

Expand All @@ -88,9 +88,9 @@ You do not need to install a license file on a machine running Linaro Forge Remo

[Free trial licenses](https://www.linaroforge.com/freeTrial/) are available for you try out Linaro Forge.

## Get started
## How do I get started with Linaro Forge?

### Debugging
### How do I debug using Linaro DDT?

When compiling the program that you want to debug, you must add the debug flag to your compile command. For most compilers this is `-g`.

Expand Down Expand Up @@ -124,7 +124,7 @@ ddt --connect -n 128 myapp

This mode is called *Reverse Connect*. A window will appear in the GUI when the application runs to notify of the incoming request.

### Profiling
### How do I profile an application with Linaro MAP?

In most cases, if your program is already compiled with debugging symbols (`-g`), you do not need to recompile your program to profile it with Linaro Forge. However, in some cases it might need to be relinked (see the [Linking](https://developer.arm.com/documentation/101136/latest/MAP/Get-started-with-MAP/Prepare-a-program-for-profiling)).

Expand All @@ -150,7 +150,7 @@ A *.map file will be created in the current directory with profiling results whe
map myapp_128p_<timestamp>.map
```

### Performance Reports
### How do I generate performance reports with Linaro Forge?

Linaro Forge's reporting tool Linaro Performance Reports is designed to run on unmodified production executables, so in general no preparation step is necessary. However, there is one important exception: statically linked applications require additional libraries at the linking step (see [user guide](https://developer.arm.com/documentation/101136/latest/Performance-Reports/Run-real-programs)).

Expand Down
8 changes: 4 additions & 4 deletions content/install-guides/fvps-on-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
---
This guide is intended to get you up and running with the [Arm Virtual Hardware (AVH) Fixed Virtual Platforms (FVPs)](https://www.arm.com/products/development-tools/simulation/virtual-hardware) on macOS. For a thorough review of all options, refer to the official documentation.

## Prerequisites
## What are the prerequisites for running AVH FVPs on macOS?

[Install Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).

If this is for commercial use, you might require a paid subscription.

## Clone the repo
## How do I clone the repository?

Open a terminal and set the working directory to the location in which you would like to store the Fast Model. Then run:

Expand All @@ -44,7 +44,7 @@ git clone https://github.com/Arm-Examples/FVPs-on-Mac.git

This creates the subdirectory `FVPs-on-Mac` in the current working directory.

## Build the Docker wrapper
## How do I build the Docker wrapper for AVH FVPs?

Run the build script to create the Docker image and populate the `bin` folder with model wrappers:

Expand All @@ -60,7 +60,7 @@ These wrappers can be used exactly like any native model executable:
./bin/FVP_MPS2_Cortex-M3 --version
```

## Expose models to local environment
## How do I expose the models to my local environment?

Add `$(pwd)/FVPs-on-Mac/bin` to `PATH` environment:

Expand Down
19 changes: 6 additions & 13 deletions content/install-guides/gfortran.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,7 @@ weight: 1

[GNU Fortran](https://gcc.gnu.org/fortran/) is the Fortran compiler front end and run-time libraries for GCC, the GNU Compiler Collection.

GFortran is available on all Linux distributions and can be installed using the package manager.

## Before you begin

Follow the instructions below to install and use `gfortran` on an Arm Linux distribution.
## How do I prepare to install and use gfortran on an Arm Linux distribution?

Confirm you are using an Arm machine by running:

Expand All @@ -45,13 +41,11 @@ aarch64

If you see a different result, you are not using an Arm computer running 64-bit Linux.

## Download
## How do I download gfortran using the Linux package manager?

The Linux package manager downloads the required files so there are no special instructions.

## Installation {#install}

### Installing on Debian based distributions such as Ubuntu
### How do I install gfortran on Debian-based distributions such as Ubuntu?

Use the `apt` command to install software packages on any Debian based Linux distribution, including Ubuntu.

Expand All @@ -60,7 +54,7 @@ sudo apt update
sudo apt install gfortran -y
```

### Installing on Red Hat / Fedora / Amazon Linux
### How do I install gfortran on Red Hat, Fedora, or Amazon Linux?

These Linux distributions use `yum` as the package manager.

Expand All @@ -78,12 +72,11 @@ sudo yum update -y
sudo yum install gcc-gfortran -y
```


## Setting up product license {#license}
## Do I need to set up a product license for gfortran?

Arm GNU Toolchain is open source and freely available for use. No licenses need to be set up for use.

## Get started {#start}
## How do I verify the gfortran installation and get started?

To confirm the installation is complete run:

Expand Down
16 changes: 8 additions & 8 deletions content/install-guides/llvm-embedded.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The [LLVM Embedded Toolchain for Arm](https://github.com/ARM-software/LLVM-embed

[Pre-built binaries](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases) are available for Windows (x86_64), macOS (x86_64 and Apple Silicon), and Linux (x86_64 and AArch64) hosts.

## Windows {#windows}
## How do I install the LLVM Embedded Toolchain for Arm on Windows? {#windows}

Copy and paste the URL below into your browser to download the latest release from GitHub:

Expand All @@ -45,7 +45,7 @@ Open Windows `Control Panel` and add the LLVM `bin` directory to the `Path`.

Open a `Command Prompt` and [test your installation](#test).

## macOS {#macos}
## How do I install the LLVM Embedded Toolchain for Arm on macOS? {#macos}

Copy and paste the URL below into your browser to download the latest release from GitHub:

Expand All @@ -70,7 +70,7 @@ find . -type f -perm +0111 | xargs xattr -d com.apple.quarantine

You can now [test your installation](#test).

## Linux {#linux}
## How do I install the LLVM Embedded Toolchain for Arm on Linux? {#linux}

The information below assumes `Ubuntu Linux` on an `AArch64` host. Modify the filenames and paths as needed for other hosts.

Expand All @@ -92,11 +92,11 @@ Add the LLVM `bin` directory to your `PATH`:
export PATH=$HOME/LLVM-ET-Arm-18.1.3-Linux-AArch64/bin:$PATH
```

You can now [test your installation](#test).
## How do I test the LLVM Embedded Toolchain installation? {#test}

## Test installation {#test}
You can now test your installation.

### Verify the clang installation
### How do I verify the clang installation?

Use the `--version` option to verify the correct compiler is being invoked:

Expand All @@ -113,7 +113,7 @@ Thread model: posix
InstalledDir: /home/ubuntu/LLVM-ET-Arm-18.1.3-Linux-AArch64/bin
```

### Build a simple application
### How do I build a simple application with clang?

Use a text editor to create an example source file with the name `hello.c` and the code below:

Expand Down Expand Up @@ -141,7 +141,7 @@ To build for `Armv7-M`:
clang --target=armv7m-none-eabi -fno-exceptions -fno-rtti -lcrt0-semihost -lsemihost -T picolibc.ld -o hello_v7m hello.c
```

### Run the examples
### How do I run the example applications?

The applications can be run on [Fixed Virtual Platforms (FVP)](/install-guides/fm_fvp/fvp/).

Expand Down
6 changes: 3 additions & 3 deletions content/install-guides/llvm-woa.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar

[LLVM version 12 or higher](https://llvm.org/) natively supports Windows on Arm. [View the supported Arm architecture features](https://developer.arm.com/Tools%20and%20Software/LLVM%20Toolchain#Supported-Devices) in the open-sourced LLVM toolchain.

## Download and install
## How do I download and install the LLVM toolchain for Windows on Arm?

The latest version (at the time of writing) of the LLVM toolchain with Windows on Arm native support is 18.1.8. [Download the pre-built binary](https://github.com/llvm/llvm-project/releases/download/llvmorg-18.1.8/LLVM-18.1.8-woa64.exe).

Expand All @@ -53,7 +53,7 @@ The setup will complete successfully. Select `Finish` to close the installer.

![img2 #center](/install-guides/_images/llvm-finish.png)

## Check the installation
## How do I check the LLVM toolchain installation?

Open a Windows Command prompt or a PowerShell prompt and run:

Expand All @@ -69,7 +69,7 @@ Thread model: posix
InstalledDir: C:\Program Files\LLVM\bin
```

## Other versions of LLVM
## What other LLVM versions are available?

You can download other LLVM builds from [the download repository](https://releases.llvm.org/download.html).

Expand Down
Loading
Loading