Skip to content

📚 Build-uenv: consistently use <build-path> #268

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
merged 1 commit into from
Sep 25, 2025
Merged

📚 Build-uenv: consistently use <build-path> #268

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
12 changes: 6 additions & 6 deletions docs/build-install/uenv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ you can provide it as an argument to `uenv-spack`:

### Build the software

Once specs have been added to `spack.yaml`, you can build the image using the `build` script that was generated in `<build-dir>`:
Once specs have been added to `spack.yaml`, you can build the image using the `build` script that was generated in `<build-path>`:

```bash
./build
Expand All @@ -216,11 +216,11 @@ The build step generates multiple outputs, described below.

### Installed packages

The packages built by Spack are installed in `<build-dir>/store`.
The packages built by Spack are installed in `<build-path>/store`.

### Spack view

A Spack view is generated in `<build-dir>/view`.
A Spack view is generated in `<build-path>/view`.

### Modules

Expand All @@ -229,15 +229,15 @@ Module files are generated in the `module` sub-directory of the `<build-path>`
To use them, add them to the module environment

```bash
module use <build-dir>/modules # (1)!
module use <build-path>/modules # (1)!
module avail # (2)!
```

1. Make modules available.
2. Check that the modules are available.

!!! note
The generation of modules can be customised by editing the `<build-dir>/config/user/modules.yaml` file _before_ running `build`.
The generation of modules can be customised by editing the `<build-path>/config/user/modules.yaml` file _before_ running `build`.
See the [Spack modules] documentation.

### Use the software
Expand All @@ -254,7 +254,7 @@ To use the installed software, you have the following options:

* Loading modules
* Activate the Spack view
* `source <build-dir>/spack/share/spack/setup-env.sh` and then use Spack
* `source <build-path>/spack/share/spack/setup-env.sh` and then use Spack

[Chaining Spack Installations]: https://spack.readthedocs.io/en/latest/chain.html
[Spack]: https://spack.readthedocs.io/en/latest/
Expand Down
Loading