Merge pull request #1326 from juliegaskin/main

Add new installation script instructions

Author: jasonrandrews

content/install-guides/streamline-cli.md

@@ -68,29 +68,67 @@ Arm recommends that you profile an optimized release build of your application,
 
 If you are using the `workflow_topdown_basic option`, ensure that your application workload is at least 20 seconds long, in order to give the core time to capture all of the metrics needed. This time increases linearly as you add more metrics to capture.
 
-## Install Streamline CLI Tools
+## Using Python scripts
 
-1. Download and extract the Streamline CLI tools on your Arm server:
+The Python scripts provided with Streamline CLI tools require Python 3.8 or later, and depend on several third-party modules. We recommend creating a Python virtual environment containing these modules to run the tools. For example:
+
+```sh
+# From Bash
+python3 -m venv sl-venv
+source ./sl-venv/bin/activate
+
+# From inside the virtual environment
+python3 -m pip install -r ./<install>/bin/requirements.txt
+```
+
+{{% notice Note%}}
+The instructions in this guide assume you have added the `<install>/bin/`
+directory to your `PATH` environment variable, and that you run all Python commands from inside the virtual environment.
+{{% /notice %}}
+
+## Installing the tools {.reference}
+
+The Streamline CLI tools are available as a standalone download to enable easy integration in to server workflows.
+
+To download the latest version of the tool and extract it to the current working directory you can use our download utility script:
+
+```sh
+wget https://artifacts.tools.arm.com/arm-performance-studio/Streamline_CLI_Tools/get-streamline-cli.py
+
+python3 get-streamline-cli.py install
+```
+
+The script can also be used to download a specific version, or install to a user-specified directory:
+
+* To list all available versions:
+
+    ```sh
+    python3 get-streamline-cli.py list
+    ```
+
+* To download, but not install, a specific version:
 
     ```sh
-    wget https://artifacts.tools.arm.com/arm-performance-studio/2024.3/Arm_Streamline_CLI_Tools_9.2.2_linux_arm64.tgz 
-    tar -xzf Arm_Streamline_CLI_Tools_9.2.2_linux_arm64.tgz 
+    python3 get-streamline-cli.py download --tool-version <version>
     ```
 
-1. The `sl-format.py` Python script requires Python 3.8 or later, and depends on several third-party modules. We recommend creating a Python virtual environment containing these modules to run the tools. For example:
+* To download and install a specific version:
 
     ```sh
-    # From Bash
-    python3 -m venv sl-venv
-    source ./sl-venv/bin/activate
+    python3 get-streamline-cli.py install --tool-version <version>
+    ```
 
-    # From inside the virtual environment
-    python3 -m pip install -r ./streamline_cli_tools/bin/requirements.txt
+* To download and install to a specific directory
+
+    ```sh
+    python3 get-streamline-cli.py install --install-dir <path>
     ```
 
-   {{% notice Note%}}
-  The instructions in this guide assume you have added the `<install>/bin/` directory to your `PATH` environment variable, and that you run all Python commands from inside the virtual environment.
-  {{% /notice %}}
+For manual download, you can find all available releases here:
+
+```sh
+https://artifacts.tools.arm.com/arm-performance-studio/Streamline_CLI_Tools/
+```
 
 ## Applying the kernel patch
 
@@ -135,10 +173,10 @@ Follow these steps to integrate these patches into an RPM-based distribution's k
 
 1. Install the RPM build tools:
 
-    ```
+    ```sh
     sudo yum install rpm-build rpmdevtools
     ```
-    
+
 1. Remove any existing `rpmbuild` directory, renaming as appropriate:
 
     ```sh
@@ -150,18 +188,21 @@ Follow these steps to integrate these patches into an RPM-based distribution's k
     ```sh
     yum download --source kernel
     ```
+
 1. Install the sources binary:
 
     ```sh
    rpm -i kernel-<VERSION>.src.rpm
     ```
 
 1. Enter the `rpmbuild` directory that is created:
+
     ```sh
     cd rpmbuild
     ```
 
 1. Copy the patch into the correct location. Replace the 9999 patch number with the next available patch number in the sequence:
+
     ```sh
     cp vX.Y-combined.patch SOURCES/9999-strobing-patch.patch
     ```

content/learning-paths/servers-and-cloud-computing/profiling-for-neoverse/streamline-cli.md

@@ -26,33 +26,23 @@ Arm recommends that you profile an optimized release build of your application,
 
 ### Procedure {.section}
 
-1. Download and extract the Streamline CLI tools on your Arm server:
+1. Use the download utility script to download the latest version of the tool and extract it to the current working directory on your Arm server:
 
     ```sh
-    wget https://artifacts.tools.arm.com/arm-performance-studio/2024.4/Arm_Streamline_CLI_Tools_9.3_linux_arm64.tgz 
-    tar -xzf Arm_Streamline_CLI_Tools_9.3_linux_arm64.tgz 
-    ```
-    
-1. Follow the instructions in the [Install Guide](/install-guides/streamline-cli/) to ensure you have everything set up correctly. Arm recommends that you apply the kernel patch as described in this guide, to improve support for capturing function-attributed top-down metrics on Arm systems.
-
-1. The `sl-format.py` Python script requires Python 3.8 or later, and depends on several third-party modules. We recommend creating a Python virtual environment containing these modules to run the tools. For example:
-
-    ```sh
-    # From Bash
-    python3 -m venv sl-venv
-    source ./sl-venv/bin/activate
+    wget https://artifacts.tools.arm.com/arm-performance-studio/Streamline_CLI_Tools/get-streamline-cli.py
 
-    # From inside the virtual environment
-    python3 -m pip install -r ./streamline_cli_tools/bin/requirements.txt
+    python3 get-streamline-cli.py install
     ```
 
-   {{% notice Note%}}
-  The instructions in this guide assume you have added the `<install>/bin/` directory to your `PATH` environment variable, and that you run all Python commands from inside the virtual environment.
-  {{% /notice %}}
+    The script can also be used to download a specific version, or install to a user-specified directory. Refer to the [Install Guide](/install-guides/streamline-cli/) for details on all the script options.
+
+    {{% notice %}}
+    Follow the instructions in the [Install Guide](/install-guides/streamline-cli/) to ensure you have everything set up correctly. Arm recommends that you apply the kernel patch as described in this guide, to improve support for capturing function-attributed top-down metrics on Arm systems.
+    {{% /notice %}}
 
 1. Use `sl-record` to capture a raw profile of your application and save the data to a directory on the filesystem.
 
-  Arm recommends making a profile of at least 20 seconds in duration, which ensures that the profiler can capture a statistically significant number of samples for all of the metrics.
+    Arm recommends making a profile of at least 20 seconds in duration, which ensures that the profiler can capture a statistically significant number of samples for all of the metrics.
 
     ```sh
     sl-record -C workflow_topdown_basic -o <output.apc> -A <your app command-line>
@@ -110,15 +100,15 @@ Arm recommends that you profile an optimized release build of your application,
 
 ## Capturing a system-wide profile
 
-To capture a system-wide profile, which captures all processes and threads, run `sl-record` with the `-S yes` option and omit the `-A ` application-specific option and following arguments.
+To capture a system-wide profile, which captures all processes and threads, run `sl-record` with the `-S yes` option and omit the `-A` application-specific option and following arguments.
 
 In systems without the kernel patches, system-wide profiles can capture the top-down metrics. To keep the captures to a usable size, it may be necessary to limit the duration of the profiles to less than 5 minutes.
 
 ## Capturing top-down metrics without the kernel patches
 
 To capture top-down metrics in a system without the kernel patches, there are three options available:
 
-* To capture a system-wide profile, which captures all processes and threads, run with the `-S yes` option and omit the `-A ` application-specific option and following arguments. To keep the captures to a usable size, it may be necessary to limit the duration of the profiles to less than 5 minutes.
+* To capture a system-wide profile, which captures all processes and threads, run with the `-S yes` option and omit the `-A` application-specific option and following arguments. To keep the captures to a usable size, it may be necessary to limit the duration of the profiles to less than 5 minutes.
 
 * To reliably capture single-threaded application profile, add the `--inherit no` option to the command line. However, in this mode metrics are only captured for the first thread in the application process and any child threads or processes are ignored.