Skip to content

doc: update doc with uv tool new workflow #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RMeli merged 1 commit into from
Dec 23, 2025
Merged

doc: update doc with uv tool new workflow #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/configuring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It can be thought of as equivalent to calling `cmake` or `configure`, performed

```bash
# configure the build
./bin/stack-config --build $BUILD_PATH --recipe $RECIPE_PATH --system $SYSTEM_CONFIG_PATH
stack-config --build $BUILD_PATH --recipe $RECIPE_PATH --system $SYSTEM_CONFIG_PATH
```

The following flags are required:
Expand Down
14 changes: 9 additions & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ A tool for building a scientific software stack from a recipe on HPE Cray EX sys

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

## Requirements

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).

## Getting Stackinator

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

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

```bash
export PATH="<stackinator-install-path>/bin:$PATH"
uv tool install --editable <path-to-stackinator-repo>
```

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

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

### Requirements

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).
!!! warning
Be careful not to share the same `uv` installation on clusters with different architectures (e.g. aarch64 vs x86_64).
You might want to install `uv` separately on each cluster and install stackinator in each `uv` installation (see [requirements](#requirements)).

### Versions

Expand Down