diff --git a/docs/configuring.md b/docs/configuring.md index a493499..099329b 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -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: diff --git a/docs/index.md b/docs/index.md index 877edc1..817e6e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. @@ -12,10 +16,10 @@ 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="/bin:$PATH" +uv tool install --editable ``` !!! info @@ -23,9 +27,9 @@ export PATH="/bin:$PATH" 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