Skip to content

Commit 9f305a4

Browse files
authored
doc: update doc with uv tool new workflow (#281)
1 parent 4c3c115 commit 9f305a4

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/configuring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ It can be thought of as equivalent to calling `cmake` or `configure`, performed
55

66
```bash
77
# configure the build
8-
./bin/stack-config --build $BUILD_PATH --recipe $RECIPE_PATH --system $SYSTEM_CONFIG_PATH
8+
stack-config --build $BUILD_PATH --recipe $RECIPE_PATH --system $SYSTEM_CONFIG_PATH
99
```
1010

1111
The following flags are required:

docs/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ A tool for building a scientific software stack from a recipe on HPE Cray EX sys
44

55
It is used to build software vClusters on Alps infrastructure at CSCS.
66

7+
## Requirements
8+
9+
To run stackinator [uv](https://docs.astral.sh/uv/getting-started/installation/) needs to be [installed](https://docs.cscs.ch/guides/terminal/#managing-x86-and-arm).
10+
711
## Getting Stackinator
812

913
To get the latest version, download directly from GitHub.
@@ -12,20 +16,20 @@ To get the latest version, download directly from GitHub.
1216
git clone https://github.com/eth-cscs/stackinator.git
1317
```
1418

15-
Once installed, add the `bin` sub-directory to your path:
19+
Once checked out, it can be installed as an application with
1620

1721
```bash
18-
export PATH="<stackinator-install-path>/bin:$PATH"
22+
uv tool install --editable <path-to-stackinator-repo>
1923
```
2024

2125
!!! info
2226
The `main` branch of Stackinator includes features for Spack v1.0, and may break older recipes.
2327

2428
For existing recipes use Spack v0.23 and earlier, use [version 5](#versions)
2529

26-
### Requirements
27-
28-
To run stackinator [uv](https://docs.astral.sh/uv/getting-started/installation/) needs to be [installed](https://docs.cscs.ch/guides/terminal/#managing-x86-and-arm).
30+
!!! warning
31+
Be careful not to share the same `uv` installation on clusters with different architectures (e.g. aarch64 vs x86_64).
32+
You might want to install `uv` separately on each cluster and install stackinator in each `uv` installation (see [requirements](#requirements)).
2933

3034
### Versions
3135

0 commit comments

Comments
 (0)