Skip to content

Commit 35d19b1

Browse files
committed
update ASCT install guide
1 parent 766801c commit 35d19b1

2 files changed

Lines changed: 18 additions & 8 deletions

File tree

18.9 KB
Loading

content/install-guides/asct.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Arm System Characterization Tool
33

4-
draft: true
5-
64
additional_search_terms:
75
- ASCT
86
- Neoverse
@@ -17,16 +15,20 @@ minutes_to_complete: 15
1715
test_maintenance: false
1816

1917
# No official documentation
20-
official_docs: https://learn.arm.com/install-guides/
18+
official_docs: https://learn.arm.com/install-guides/asct/
2119

2220
author: Jason Andrews
2321

2422
### PAGE SETUP
2523
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
26-
tool_install: true # Set to true to be listed in main selection page, else false
24+
tool_install: false # Set to true to be listed in main selection page, else false
2725
multi_install: false # Set to true if first page of multi-page article, else false
2826
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
2927
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
28+
29+
build:
30+
list: false
31+
render: true
3032
---
3133

3234
The Arm System Characterization Tool (ASCT) is a command-line utility for running low-level benchmarks, diagnostic scripts, and system tests to analyze and debug performance on Arm-based platforms. ASCT provides a standardized environment for evaluating key hardware characteristics and is especially suited for platform bring-up, system tuning, and architectural comparison tasks.
@@ -82,10 +84,10 @@ ASCT is distributed as a Python package and requires Python 3.10 or later.
8284

8385
Download the latest ASCT release from the [artifacts.tools.arm.com](https://artifacts.tools.arm.com/asct/dist/) page.
8486

85-
For example, to download version 0.4.1:
87+
For example, to download version 0.4.2:
8688

8789
```bash
88-
wget https://artifacts.tools.arm.com/asct/dist/0.4.1/asct-0.4.1+a304bc8.tar.gz
90+
wget https://artifacts.tools.arm.com/asct/dist/0.4.2/asct-0.4.2+3b955c2.tar.gz
8991
```
9092

9193
### How do I install ASCT using uv?
@@ -99,7 +101,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
99101
Install ASCT system-wide using:
100102

101103
```bash
102-
UV_TOOL_BIN_DIR=/usr/local/bin sudo -E $(which uv) tool install asct-0.4.1+a304bc8.tar.gz
104+
UV_TOOL_BIN_DIR=/usr/local/bin sudo -E $(which uv) tool install asct-0.4.2+3b955c2.tar.gz
103105
```
104106

105107
This installs ASCT to `/usr/local/bin` making it available system-wide. Installing to `/usr/local/bin` instead of the default `~/.local/bin` allows you to run ASCT with `sudo`, which is required for some benchmarks to access system resources and configure huge pages.
@@ -115,7 +117,7 @@ asct version
115117
The output is similar to:
116118

117119
```output
118-
ASCT 0.4.1+a304bc8
120+
ASCT 0.4.2+3b955c2
119121
```
120122

121123
You can also display the help information:
@@ -261,6 +263,14 @@ ASCT provides several additional options:
261263
- `--no-cache` - Disable cached benchmark data
262264
- `--clear-cache` - Clear cached benchmark data
263265

266+
Setting `--log-level` to `debug` is useful if the tests are not running due to permission settings or a missing software dependency.
267+
268+
Some of the tests also generate graphs.
269+
270+
An example of a bandwidth graph is shown below:
271+
272+
![Example bandwidth sweep benchmark output showing memory bandwidth measurements across different data sizes on an Arm system, with a graph displaying bandwidth in GB/s on the y-axis and data size in MB on the x-axis](/install-guides/_images/asct-bw.webp)
273+
264274
## How do I uninstall ASCT?
265275

266276
If you installed ASCT using `uv`, remove it with:

0 commit comments

Comments
 (0)