Skip to content

Commit 638cfb6

Browse files
Merge pull request #1341 from jasonrandrews/review
Review Streamline CLI install guide
2 parents e23a734 + fdd0e0a commit 638cfb6

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

content/install-guides/streamline-cli.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,20 @@ If you are using the `workflow_topdown_basic option`, ensure that your applicati
7070

7171
## Using Python scripts
7272

73-
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:
73+
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.
74+
75+
Create a virtual environment:
7476

7577
```sh
7678
# From Bash
7779
python3 -m venv sl-venv
7880
source ./sl-venv/bin/activate
79-
80-
# From inside the virtual environment
81-
python3 -m pip install -r ./<install>/bin/requirements.txt
8281
```
8382

83+
The prompt of your terminal has (sl-venv) as a prefix indicating the virtual environment is active.
84+
8485
{{% notice Note%}}
85-
The instructions in this guide assume you have added the `<install>/bin/`
86-
directory to your `PATH` environment variable, and that you run all Python commands from inside the virtual environment.
86+
The instructions assume that you run all Python commands from inside the virtual environment.
8787
{{% /notice %}}
8888

8989
## Installing the tools {.reference}
@@ -94,8 +94,14 @@ To download the latest version of the tool and extract it to the current working
9494

9595
```sh
9696
wget https://artifacts.tools.arm.com/arm-performance-studio/Streamline_CLI_Tools/get-streamline-cli.py
97-
9897
python3 get-streamline-cli.py install
98+
python3 -m pip install -r ./streamline_cli_tools/bin/requirements.txt
99+
```
100+
101+
If you want to add the Streamline tools to your search path:
102+
103+
```sh
104+
export PATH=$PATH:$PWD/streamline_cli_tools/bin
99105
```
100106

101107
The script can also be used to download a specific version, or install to a user-specified directory:

0 commit comments

Comments
 (0)