Skip to content

Commit

Permalink
auto-update docs for EasyBuild v4.8.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@boegel
boegel committed Oct 29, 2023
1 parent 70f737b commit fde660f
Show file tree
Hide file tree
Showing 4 changed files with 1,014 additions and 338 deletions.
7 changes: 7 additions & 0 deletions docs/version-specific/easyconfig-templates.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,22 @@ Template name |Template value

Template name |Template value
--------------------|------------------------------------------------
``%(cudamajver)s`` |major version for CUDA
``%(cudashortver)s``|short version for CUDA (``<major>.<minor>``)
``%(cudaver)s`` |full version for CUDA
``%(cudamajver)s`` |major version for CUDAcore
``%(cudashortver)s``|short version for CUDAcore (``<major>.<minor>``)
``%(cudaver)s`` |full version for CUDAcore
``%(javamajver)s`` |major version for Java
``%(javashortver)s``|short version for Java (``<major>.<minor>``)
``%(javaver)s`` |full version for Java
``%(perlmajver)s`` |major version for Perl
``%(perlshortver)s``|short version for Perl (``<major>.<minor>``)
``%(perlver)s`` |full version for Perl
``%(pymajver)s`` |major version for Python
``%(pyshortver)s`` |short version for Python (``<major>.<minor>``)
``%(pyver)s`` |full version for Python
``%(rmajver)s`` |major version for R
``%(rshortver)s`` |short version for R (``<major>.<minor>``)
``%(rver)s`` |full version for R

Expand Down Expand Up @@ -59,6 +65,7 @@ Template name |Template value
Template name |Template value
---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------
``%(arch)s`` |System architecture (e.g. x86_64, aarch64, ppc64le, ...)
``%(sysroot)s`` |Location root directory of system, prefix for standard paths like /usr/lib and /usr/includeas specify by the --sysroot configuration option
``%(mpi_cmd_prefix)s`` |Prefix command for running MPI programs (with default number of ranks)
``%(cuda_compute_capabilities)s``|Comma-separated list of CUDA compute capabilities, as specified via --cuda-compute-capabilities configuration option or via cuda_compute_capabilities easyconfig parameter
``%(cuda_cc_cmake)s`` |List of CUDA compute capabilities suitable for use with $CUDAARCHS in CMake 3.18+
Expand Down
40 changes: 20 additions & 20 deletions docs/version-specific/eb-help.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,26 @@ Option flag |Option description

## Basic options

Option flag |Option description
---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
``--dry-run`` |Print build overview incl. dependencies (full paths) (default: False)
``-D, --dry-run-short`` |Print build overview incl. dependencies (short paths) (default: False)
``-x, --extended-dry-run`` |Print build environment and (expected) build procedure that will be performed (default: False)
``--extended-dry-run-ignore-errors`` |Ignore errors that occur during dry run (default: True; disable with --disable-extended-dry-run-ignore-errors)
``-f, --force`` |Force to rebuild software even if it's already installed (i.e. if it can be found as module), and skipping check for OS dependencies (default: False)
``--ignore-locks`` |Ignore locks that prevent two identical installations running in parallel (default: False)
``--job`` |Submit the build as a job (default: False)
``--locks-dir=LOCKS-DIR`` |Directory to store lock files (should be on a shared filesystem); None implies .locks subdirectory of software installation directory
``-l, --logtostdout`` |Redirect main log to stdout (default: False)
``-M, --missing-modules`` |Print list of missing modules for dependencies of specified easyconfigs (default: False)
``-b BLOCKS, --only-blocks=BLOCKS`` |Only build listed blocks (type comma-separated list)
``--rebuild`` |Rebuild software, even if module already exists (don't skip OS dependencies checks) (default: False)
``-r PATH[:PATH], --robot=PATH[:PATH]``|Enable dependency resolution, using easyconfigs in specified paths (type pathsep-separated list)
``--robot-paths=PATH[:PATH]`` |Additional paths to consider by robot for easyconfigs (--robot paths get priority) (type pathsep-separated list; default: /home/example/work/easybuild-easyconfigs/easybuild/easyconfigs)
``--search-paths=PATH[:PATH]`` |Additional locations to consider in --search (next to --robot and --robot-paths paths) (type pathsep-separated list)
``-k, --skip`` |Skip existing software (useful for installing additional packages) (default: False)
``-s STOP, --stop=STOP`` |Stop the installation after certain step (type choice; default: source) (choices: fetch, ready, source, patch, prepare, configure, build, test, install, extensions, postiter, postproc, sanitycheck, cleanup, module, permissions, package, testcases)
``--strict=STRICT`` |Set strictness level (type choice; default: warn) (choices: ignore, warn, error)
Option flag |Option description
-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
``--dry-run`` |Print build overview incl. dependencies (full paths) (default: False)
``-D, --dry-run-short`` |Print build overview incl. dependencies (short paths) (default: False)
``-x, --extended-dry-run`` |Print build environment and (expected) build procedure that will be performed (default: False)
``--extended-dry-run-ignore-errors`` |Ignore errors that occur during dry run (default: True; disable with --disable-extended-dry-run-ignore-errors)
``-f, --force`` |Force to rebuild software even if it's already installed (i.e. if it can be found as module), and skipping check for OS dependencies (default: False)
``--ignore-locks`` |Ignore locks that prevent two identical installations running in parallel (default: False)
``--job`` |Submit the build as a job (default: False)
``--locks-dir=LOCKS-DIR`` |Directory to store lock files (should be on a shared filesystem); None implies .locks subdirectory of software installation directory
``-l, --logtostdout`` |Redirect main log to stdout (default: False)
``-M, --missing-modules`` |Print list of missing modules for dependencies of specified easyconfigs (default: False)
``-b BLOCKS, --only-blocks=BLOCKS`` |Only build listed blocks (type comma-separated list)
``--rebuild`` |Rebuild software, even if module already exists (don't skip OS dependencies checks) (default: False)
``-r [PATH[:PATH]], --robot=[PATH[:PATH]]``|Enable dependency resolution, optionally consider additional paths to search for easyconfigs (type pathsep-separated list)
``--robot-paths=PATH[:PATH]`` |Additional paths to consider by robot for easyconfigs (--robot paths get priority) (type pathsep-separated list; default: /home/example/work/easybuild-easyconfigs/easybuild/easyconfigs)
``--search-paths=PATH[:PATH]`` |Additional locations to consider in --search (next to --robot and --robot-paths paths) (type pathsep-separated list)
``-k, --skip`` |Skip existing software (useful for installing additional packages) (default: False)
``-s STOP, --stop=STOP`` |Stop the installation after certain step (type choice; default: source) (choices: fetch, ready, source, patch, prepare, configure, build, test, install, extensions, postiter, postproc, sanitycheck, cleanup, module, permissions, package, testcases)
``--strict=STRICT`` |Set strictness level (type choice; default: warn) (choices: ignore, warn, error)

## Configuration options

Expand Down
Loading

0 comments on commit fde660f

Please sign in to comment.