Skip to content
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.

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

update docs for release of EasyBuild v4.9.1 #250

Merged
merged 28 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
cd3576f
Clarify module sort order differences
xdelaruelle Nov 2, 2023
e3b8d37
Describe MODULES_CMD env var use to search module tool
xdelaruelle Nov 2, 2023
38a3f3b
Adapt unit-tests now Lmod is default module tool
xdelaruelle Nov 2, 2023
f790109
See hidden modules on Environment Modules with --all
xdelaruelle Nov 2, 2023
5d6af30
RPATH on by default
branfosj Feb 7, 2024
5173b12
environment
branfosj Feb 7, 2024
7665205
Apply suggestions from code review
branfosj Feb 7, 2024
53be64f
Apply suggestions from code review
branfosj Feb 8, 2024
f586a30
fix extra ) in paragraph on using --filter-env-vars with RPATH
boegel Feb 14, 2024
f087e44
Merge pull request #241 from branfosj/develop
boegel Feb 14, 2024
1791ff8
split out default config changes and remove proposed changes
branfosj Feb 16, 2024
39ffaa0
Merge pull request #224 from xdelaruelle/module_sort_order
ocaisa Feb 23, 2024
3162174
Merge pull request #225 from xdelaruelle/MODULES_CMD
ocaisa Feb 23, 2024
7008df9
Update docs/unit-tests.md
ocaisa Feb 23, 2024
0739349
Merge pull request #226 from xdelaruelle/unit_test_lmod_is_default
ocaisa Feb 23, 2024
c96c5c0
Merge pull request #227 from xdelaruelle/show_hidden_modules
ocaisa Feb 23, 2024
5495612
redirect proposed changes to EB5 index
branfosj Mar 4, 2024
ca2a194
yaml lint
branfosj Mar 4, 2024
118ddcc
Merge pull request #242 from branfosj/config
boegel Mar 13, 2024
80e436a
fix toolchain graph
smoors Mar 25, 2024
54bc1e7
Merge pull request #245 from smoors/scalapack
boegel Apr 2, 2024
654298a
auto-update docs for EasyBuild v4.9.1
boegel Apr 4, 2024
5efb7ca
Merge pull request #248 from boegel/eb491_auto_update_docs
bedroge Apr 4, 2024
ebbaa59
update release notes + bump version for EasyBuild v4.9.1
boegel Apr 5, 2024
ad67721
Merge branch 'eb491_rel_notes'
boegel Apr 5, 2024
edd0a49
Typo fix for LAMMPS easy block note
verdurin Apr 5, 2024
0cf15a4
Merge pull request #249 from boegel/eb491_rel_notes
verdurin Apr 5, 2024
a94659e
Merge branch 'develop'
boegel Apr 5, 2024
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
4 changes: 2 additions & 2 deletions docs/common-toolchains.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ graph LR
A --> |binutils| C[intel-compilers];
B --> |OpenMPI| E[gompi];
C --> |impi| F[iimpi];
B --> |FlexiBLAS + FFTW + ScaLAPACK| D[gfbf];
D --> |OpenMPI| G[foss];
B --> |FlexiBLAS (incl. LAPACK) + FFTW| D[gfbf];
D --> |OpenMPI + ScaLAPACK| G[foss];
E --> |FlexiBLAS + FFTW + ScaLAPACK| G[foss];
F --> |imkl| Z[intel];
C --> |imkl| H[iimkl];
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,9 @@ output of `type -f module` (in a `bash` shell), or `alias module` (in a `tcsh` s

The actual module command (i.e., `modulecmd`, `modulecmd.tcl`,
`lmod`, ...) must be available via `$PATH` (which is not standard), except when using Lmod
(in that case the `lmod` binary can also be located via `$LMOD_CMD`).
(in that case the `lmod` binary can also be located via `$LMOD_CMD`) or when using
Environment Modules (in that case the `modulecmd.tcl` binary can also be located via
`$MODULES_CMD`).

For example, to indicate that EasyBuild should be using `Lmod` as modules tool:

Expand Down
52 changes: 52 additions & 0 deletions docs/easybuild-v5/changes-in-default-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Changes in default configuration in EasyBuild v5.0

*(for a full overview of changes in EasyBuild v5.0, see [here](overview-of-changes.md))*

Various changes in default configuration included in EasyBuild v5.0, including:

* [Enable RPATH linking by default][rpath]
* [Enable `--trace` by default][trace]

---

## Enable RPATH linking by default {: #rpath }

[RPATH linking][rpath_support] is enabled by default in EasyBuild v5.0 (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)).

The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why].

This enhancement **does not** add any filtering of environment variables. This means `$LD_LIBRARY_PATH`
will continue to be appended by the environment module files EasyBuild generates,
unless it is configured to filter these variables (via `--filter-env-vars`,
see also [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]).

To disable RPATH linking, either:

* Use the `--disable-rpath` command line option;
* Set the `$EASYBUILD_DISABLE_RPATH` environment variable;
* Disable RPATH linking in an EasyBuild [configuration file](../configuration.md#configuration_file):

``` ini
[override]
rpath=0
```


---

## Enable `--trace` by default {: #trace }

The [`--trace` option](../tracing-progress.md) is enabled by default (see [easybuild-framework PR #4250](https://github.com/easybuilders/easybuild-framework/pull/4250)).

This makes the output produced by the `eb` command more informative, by providing more information about what's going on in the background.

To disable trace output, either:

* Use the `--disable-trace` command line option;
* Set the `$EASYBUILD_DISABLE_TRACE` environment variable;
* Disable trace mode in a [configuration file](../configuration.md#configuration_file):

``` ini
[override]
trace=0
```
19 changes: 0 additions & 19 deletions docs/easybuild-v5/enhancements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,10 @@
Various significant enhancements are included in EasyBuild v5.0, including:

* [`run_shell_cmd` function][run_shell_cmd]
* [Enable `--trace` by default][trace]

---

## `run_shell_cmd` function { : #run_shell_cmd }

See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md).

---

## Enable `--trace` by default {: #trace }

The [`--trace` option](../tracing-progress.md) is enabled by default (see [easybuild-framework PR #4250](https://github.com/easybuilders/easybuild-framework/pull/4250)).

This makes the output produced by the `eb` command more informative, by providing more information about what's going on in the background.

To disable trace output, either:

* Use the `--disable-trace` command line option;
* Set the `$EASYBUILD_DISABLE_TRACE` environment variable;
* Disable trace mode in a [configuration file](../configuration.md#configuration_file):

``` ini
[override]
trace=0
```
1 change: 1 addition & 0 deletions docs/easybuild-v5/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [Overview of changes](overview-of-changes.md)
- [Backwards-incompatible changes](backwards-incompatible-changes.md)
- [Changes in default configuration](changes-in-default-configuration.md)
- [Enhancements](enhancements.md)
- [`run_shell_cmd` function](run_shell_cmd.md)
- [Deprecated functionality](deprecated-functionality.md)
Expand Down
5 changes: 2 additions & 3 deletions docs/easybuild-v5/overview-of-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
!!! warning
EasyBuild 5.0 is currently still under development, via the `5.0.x` branches in the EasyBuild GitHub repositories.

We intend to update this section of the documentation regularly as the planned changes are being implemented,
and when there are [proposed changes](proposed-changes.md) where we are requesting community feedback.
We intend to update this section of the documentation regularly as the planned changes are being implemented.

This page provides a concise overview of the most prominent changes in EasyBuild version 5.0,
which can be categorized as:

* [Enhancements](enhancements.md)
* [Changes in default configuration](changes-in-default-configuration.md)
* [Backward-incompatible changes](backwards-incompatible-changes.md)
* [Deprecated functionality](deprecated-functionality.md)
* [Proposed changes](proposed-changes.md)
* [Policies](policies.md)

For in-depth details on a particular change, see the pull requests that are linked
Expand Down
9 changes: 0 additions & 9 deletions docs/easybuild-v5/proposed-changes.md

This file was deleted.

16 changes: 10 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ This is EasyBuild 4.8.0 (framework: 4.8.0, easyblocks: 4.8.0) on host example.lo
```

!!! tip
The Tcl-based or Lmod implementations of environment modules do their default sorting differently.
The former will normally sort in the lexicographic order, while Lmod follows
an approach that is closer to Python's construct `LooseVersion` way of ordering. Such aspects
may make a big difference, if you have installed both versions 1.9.0 and 1.15.2,
with respect to what is the version being loaded by default.
The Tcl/C Environment Modules (version <= 3.2.10) does its default sorting differently than
newer versions of Environment Modules and Lmod. The former will normally sort in the
lexicographic order, while the latters follow an approach that is closer to Python's construct
`LooseVersion` way of ordering. Such aspects may make a big difference, if you have installed
both versions 1.9.0 and 1.15.2, with respect to what is the version being loaded by default.

You can also run `eb --show-system-info` to see system information relevant to EasyBuild,
or run`eb --show-config` to see the default EasyBuild configuration (see also [Configuring EasyBuild][configuring_easybuild]).
Expand Down Expand Up @@ -356,12 +356,16 @@ Supported module tools:
the `module` function; for example, using `type module` or `type -f module`.

!!! note
For Lmod specifically, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
For Lmod, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
environment variable, in case `lmod` is not available in `$PATH`.

In EasyBuild versions *prior* to 2.1.1, the path specified by `$LMOD_CMD` was (erroneously) preferred over the
(first) `lmod` binary available via `$PATH`.

For modern Tcl-only environment modules (version >= 4.0.0), EasyBuild will try to fall back to finding the
`modulecmd.tcl` binary via the `$MODULES_CMD` environment variable, in case `modulecmd.tcl` is not available
in `$PATH`.


Additional notes:

Expand Down
4 changes: 2 additions & 2 deletions docs/manipulating-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ $ eb HDF5-1.8.13-intel-2015a.eb --hide-deps=zlib,Szip -D
```

!!! note
Using Lmod (version >= 5.7.5), hidden modules can be made visible in the output of '`module avail`' using the
`--show-hidden` option.
Using Lmod (version >= 5.7.5) or Environment Modules (version >= 4.6.0), hidden modules can be made
visible in the output of '`module avail`' using respectively the `--show-hidden` or `--all` option.

For example:

Expand Down
Loading
Loading