Skip to content

Commit 31d01c8

Browse files
jfgrimmjfgrimm
authored
Merge pull request #345 from boegel/eb512_auto_update_docs
auto-update docs for EasyBuild v5.1.2
2 parents 61f9278 + 07ce7b2 commit 31d01c8

File tree

659 files changed

+2426
-109
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

659 files changed

+2426
-109
lines changed

‎docs/version-specific/easyblocks.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@
263263
- SystemMPI
264264
- EB_Inspector
265265
- EB_intel_minus_compilers
266+
- EB_ipp
266267
- EB_itac
267268
- EB_tbb
268269
- EB_VTune

‎docs/version-specific/easyconfig-constants.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ Constant name |Constant value
1515
``OS_TYPE`` |``Darwin`` |System type (e.g. 'Linux' or 'Darwin')
1616
``OS_VERSION`` |``UNKNOWN`` |System version
1717
``SYSTEM`` |``{'name': 'system', 'version': 'system'}`` |System toolchain
18-
``SYS_PYTHON_VERSION`` |``3.11.10`` |System Python version (platform.python_version())
18+
``SYS_PYTHON_VERSION`` |``3.13.3`` |System Python version (platform.python_version())
1919

2020
*(see also* ``eb --avail-easyconfig-constants`` *)*

‎docs/version-specific/easyconfig-parameters.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525
**Parameter name** |**Description** |**Default value**|**Alternative name**
2626
-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------------------------
27+
`amdgcn_capabilities` |List of AMDGCN capabilities to build with (if supported) |`[]` |
2728
`banned_linked_shared_libs` |List of shared libraries (names, file names, or paths) which are not allowed to be linked in any installed binary/library |`[]` |
2829
`bin_lib_subdirs` |List of subdirectories for binaries and libraries, which is used during sanity check to check RPATH linking and banned/required libraries |`[]` |
2930
`bitbucket_account` |Bitbucket account name to be used to resolve template values in source URLs |`"%(namelower)s"`|

‎docs/version-specific/easyconfig-templates.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ Template name |Template value
6464
Template name |Template value
6565
-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------
6666
``%(arch)s`` |System architecture (e.g. x86_64, aarch64, ppc64le, ...)
67+
``%(amdgcn_capabilities)s`` |Comma-separated list of AMDGCN capabilities, as specified via --amdgcn-capabilities configuration option or via amdgcn_capabilities easyconfig parameter
68+
``%(amdgcn_cc_space_sep)s`` |Space-separated list of AMDGCN capabilities
69+
``%(amdgcn_cc_semicolon_sep)s`` |Semicolon-separated list of AMDGCN capabilities
6770
``%(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
6871
``%(cuda_cc_cmake)s`` |List of CUDA compute capabilities suitable for use with $CUDAARCHS in CMake 3.18+
6972
``%(cuda_cc_space_sep)s`` |Space-separated list of CUDA compute capabilities

‎docs/version-specific/eb-help.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Option flag |Option descrip
8383
``--job-backend=JOB-BACKEND`` |Backend to use for submitting jobs (type choice; default: Slurm) (choices: GC3Pie, PbsPython, Slurm)
8484
``--logfile-format=DIR,FORMAT`` |Directory name and format of the log file (type comma-separated tuple; default: easybuild,easybuild-%(name)s-%(version)s-%(date)s.%(time)s.log)
8585
``--module-depends-on`` |Use depends_on (Lmod 7.6.1+) for dependencies in all generated modules (implies recursive unloading of modules). (default: True; disable with --disable-module-depends-on)
86-
``--module-extensions`` |Include 'extensions' statement in generated module file (Lua syntax only) (default: True; disable with --disable-module-extensions)
86+
``--module-extensions`` |Include 'extensions' statement in generated module file (default: True; disable with --disable-module-extensions)
8787
``--module-naming-scheme=MODULE-NAMING-SCHEME`` |Module naming scheme to use (default: EasyBuildMNS)
8888
``--module-search-path-headers=MODULE-SEARCH-PATH-HEADERS`` |Environment variable set by modules on load with search paths to header files (type choice; default: cpath) (choices: cpath, include_paths)
8989
``--module-syntax=MODULE-SYNTAX`` |Syntax to be used for module files (type choice; default: Lua) (choices: Lua, Tcl)
@@ -234,6 +234,7 @@ Option flag |Option
234234
``--allow-modules-tool-mismatch`` |Allow mismatch of modules tool and definition of 'module' function (default: False)
235235
``--allow-unresolved-templates`` |Don't error out when templates such as %(name)s in EasyConfigs could not be resolved (default: False)
236236
``--allow-use-as-root-and-accept-consequences`` |Allow using of EasyBuild as root (NOT RECOMMENDED!) (default: False)
237+
``--amdgcn-capabilities=AMDGCN-CAPABILITIES`` |List of AMDGCN capabilities to use when building GPU software; values should be specified as gfx[xyz], as defined by the LLVM targets, for example: gfx1101,gfx90a,gfx1030 (type comma-separated list)
237238
``--backup-modules`` |Back up an existing module file, if any. Auto-enabled when using --module-only or --skip
238239
``--backup-patched-files`` |Create a backup (*.orig) file when applying a patch (default: False)
239240
``--banned-linked-shared-libs=BANNED-LINKED-SHARED-LIBS`` |Comma-separated list of shared libraries (names, file names, or paths) which are not allowed to be linked in any installed binary/library (type comma-separated list)

‎docs/version-specific/generic-easyblocks.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,16 @@ Build environment of toolchain: only generate module file
9595

9696
### Extra easyconfig parameters specific to ``BuildEnv`` easyblock
9797

98-
easyconfig parameter |description |default value
99-
-------------------------------|---------------------------------------------------------------------------|-------------
100-
``altroot`` |Software name of dependency to use to define $EBROOT for this bundle |``None``
101-
``altversion`` |Software name of dependency to use to define $EBVERSION for this bundle |``None``
102-
``components`` |List of components to install: tuples w/ name, version and easyblock to use|``()``
103-
``default_component_specs`` |Default specs to use for every component |``{}``
104-
``default_easyblock`` |Default easyblock to use for components |``None``
105-
``sanity_check_all_components``|Enable sanity checks for all components |``False``
106-
``sanity_check_components`` |List of components for which to run sanity checks |``[]``
98+
easyconfig parameter |description |default value
99+
-------------------------------|--------------------------------------------------------------------------------------------------------|-------------
100+
``altroot`` |Software name of dependency to use to define $EBROOT for this bundle |``None``
101+
``altversion`` |Software name of dependency to use to define $EBVERSION for this bundle |``None``
102+
``components`` |List of components to install: tuples w/ name, version and easyblock to use |``()``
103+
``default_component_specs`` |Default specs to use for every component |``{}``
104+
``default_easyblock`` |Default easyblock to use for components |``None``
105+
``python_executable`` |Python executable to use for the wrappers (use None to use path to Python executable used by EasyBuild).|``"python3"``
106+
``sanity_check_all_components``|Enable sanity checks for all components |``False``
107+
``sanity_check_components`` |List of components for which to run sanity checks |``[]``
107108

108109
### Customised steps in ``BuildEnv`` easyblock
109110

@@ -191,7 +192,7 @@ easyconfig parameter |description
191192
``install_target_subdir`` |Subdirectory to use as installation target |``None``
192193
``prefix_opt`` |Prefix command line option for configure script ('--prefix=' if None) |``None``
193194
``runtest`` |Make target to test build or True to use CTest |``None``
194-
``separate_build_dir`` |Perform build in a separate directory |``True``
195+
``separate_build_dir`` |Perform build in a separate directory. Can be set to a specific path to use, otherwise a new, empty folder is created. A relative path is relative to %(builddir)s. To build in the source directory set this to 'False'. |``True``
195196
``srcdir`` |Source directory location to provide to cmake command |``None``
196197
``tar_config_opts`` |Override tar settings as determined by configure. |``False``
197198
``test_cmd`` |Test command to use ('runtest' value is appended, default: 'make') |``None``
@@ -271,7 +272,7 @@ easyconfig parameter |description
271272
``install_target_subdir`` |Subdirectory to use as installation target |``None``
272273
``prefix_opt`` |Prefix command line option for configure script ('--prefix=' if None) |``None``
273274
``runtest`` |Make target to test build or True to use CTest |``None``
274-
``separate_build_dir`` |Perform build in a separate directory |``True``
275+
``separate_build_dir`` |Perform build in a separate directory. Can be set to a specific path to use, otherwise a new, empty folder is created. A relative path is relative to %(builddir)s. To build in the source directory set this to 'False'. |``True``
275276
``srcdir`` |Source directory location to provide to cmake command |``None``
276277
``tar_config_opts`` |Override tar settings as determined by configure. |``False``
277278
``test_cmd`` |Test command to use ('runtest' value is appended, default: 'make') |``None``
@@ -314,7 +315,7 @@ easyconfig parameter |description
314315
``install_target_subdir`` |Subdirectory to use as installation target |``None``
315316
``prefix_opt`` |Prefix command line option for configure script ('--prefix=' if None) |``None``
316317
``runtest`` |Ninja target to test build or True to use CTest |``None``
317-
``separate_build_dir`` |Perform build in a separate directory |``True``
318+
``separate_build_dir`` |Perform build in a separate directory. Can be set to a specific path to use, otherwise a new, empty folder is created. A relative path is relative to %(builddir)s. To build in the source directory set this to 'False'. |``True``
318319
``srcdir`` |Source directory location to provide to cmake command |``None``
319320
``tar_config_opts`` |Override tar settings as determined by configure. |``False``
320321
``test_cmd`` |Test command to use ('runtest' value is appended) |``"ninja"``
@@ -376,7 +377,7 @@ easyconfig parameter |description
376377
``req_py_minver`` |Required minor Python version (only relevant when using system Python) |``None``
377378
``runtest`` |Make target to test build or True to use CTest |``None``
378379
``sanity_pip_check`` |Run 'python -m pip check' to ensure all required Python packages are installed and check for any package with an invalid (0.0.0) version. |``True``
379-
``separate_build_dir`` |Perform build in a separate directory |``True``
380+
``separate_build_dir`` |Perform build in a separate directory. Can be set to a specific path to use, otherwise a new, empty folder is created. A relative path is relative to %(builddir)s. To build in the source directory set this to 'False'. |``True``
380381
``source_urls`` |List of URLs for source files |``['https://pypi.python.org/packages/source/%(nameletter)s/%(name)s']``
381382
``srcdir`` |Source directory location to provide to cmake command |``None``
382383
``tar_config_opts`` |Override tar settings as determined by configure. |``False``

0 commit comments

Comments
 (0)