Skip to content

Commit 4535d9e

Browse files
committed
auto-update docs for EasyBuild v5.1.0
1 parent 2d23722 commit 4535d9e

File tree

370 files changed

+1749
-154
lines changed

Some content is hidden

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

370 files changed

+1749
-154
lines changed

docs/version-specific/easyblocks.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
- **EasyBlock**
44
- Binary
55
- Conda
6+
- Dataset
67
- EB_ABAQUS
78
- EB_Anaconda
89
- EB_Mamba
@@ -157,13 +158,15 @@
157158
- CMakeMakeCp
158159
- EB_DualSPHysics
159160
- CmdCp
161+
- EB_fastStructure
160162
- EB_BLAT
161163
- EB_Bowtie2
162164
- EB_MetalWalls
163165
- EB_MXNet
164166
- EB_NAMD
165167
- EB_ORCA
166168
- PerlModule
169+
- EB_Term_colon__colon_ReadLine_colon__colon_Gnu
167170
- SystemMPI
168171
- EB_ADF
169172
- EB_Bazel
@@ -199,6 +202,7 @@
199202
- OCamlPackage
200203
- OctavePackage
201204
- PerlModule
205+
- EB_Term_colon__colon_ReadLine_colon__colon_Gnu
202206
- PythonPackage
203207
- CargoPythonPackage
204208
- CMakePythonPackage
@@ -242,6 +246,7 @@
242246
- EB_Hadoop
243247
- EB_RepeatMasker
244248
- EB_RepeatModeler
249+
- EB_VSCode
245250
- GoPackage
246251
- IntelBase
247252
- EB_Advisor
@@ -298,6 +303,7 @@
298303
- OCamlPackage
299304
- OctavePackage
300305
- PerlModule
306+
- EB_Term_colon__colon_ReadLine_colon__colon_Gnu
301307
- PythonPackage
302308
- CargoPythonPackage
303309
- CMakePythonPackage
@@ -341,5 +347,6 @@
341347
- EB_Hadoop
342348
- EB_RepeatMasker
343349
- EB_RepeatModeler
350+
- EB_VSCode
344351

345352
*(see also* ``eb --list-easyblocks`` and* [*overview of generic easyblocks*][generic_easyblocks] *)*

docs/version-specific/easyconfig-parameters.md

Lines changed: 54 additions & 51 deletions
Large diffs are not rendered by default.

docs/version-specific/eb-help.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Option flag |Option description
6161
## Configuration options
6262

6363
Option flag |Option description
64-
-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
64+
-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
6565
``--avail-module-naming-schemes`` |Show all supported module naming schemes (default: False)
6666
``--avail-modules-tools`` |Show all supported module tools (default: False)
6767
``--avail-repositories`` |Show all repository types (incl. non-usable) (default: False)
@@ -77,6 +77,7 @@ Option flag |Option descrip
7777
``--include-module-naming-schemes=INCLUDE-MODULE-NAMING-SCHEMES``|Location(s) of extra or customized module naming schemes (type comma-separated list)
7878
``--include-toolchains=INCLUDE-TOOLCHAINS`` |Location(s) of extra or customized toolchains or toolchain components (type comma-separated list)
7979
``--installpath=INSTALLPATH`` |Install path for software and modules (default: /home/example/.local/easybuild)
80+
``--installpath-data=INSTALLPATH-DATA`` |Install path for data (if None, combine --installpath and --subdir-data)
8081
``--installpath-modules=INSTALLPATH-MODULES`` |Install path for modules (if None, combine --installpath and --subdir-modules)
8182
``--installpath-software=INSTALLPATH-SOFTWARE`` |Install path for software (if None, combine --installpath and --subdir-software)
8283
``--job-backend=JOB-BACKEND`` |Backend to use for submitting jobs (type choice; default: Slurm) (choices: GC3Pie, PbsPython, Slurm)
@@ -86,19 +87,21 @@ Option flag |Option descrip
8687
``--module-naming-scheme=MODULE-NAMING-SCHEME`` |Module naming scheme to use (default: EasyBuildMNS)
8788
``--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)
8889
``--module-syntax=MODULE-SYNTAX`` |Syntax to be used for module files (type choice; default: Lua) (choices: Lua, Tcl)
89-
``--moduleclasses=MODULECLASSES`` |Extend supported module classes (For more info on the default classes, use --show-default-moduleclasses) (type comma-separated list; default: base,ai,astro,bio,cae,chem,compiler,data,debugger,devel,geo,ide,lang,lib,math,mpi,numlib,perf,quantum,phys,system,toolchain,tools,vis)
90+
``--moduleclasses=MODULECLASSES`` |Extend supported module classes (For more info on the default classes, use --show-default-moduleclasses) (type comma-separated list; default: base,ai,astro,bio,cae,chem,compiler,data,dataset,debugger,devel,geo,ide,lang,lib,math,mpi,numlib,perf,quantum,phys,system,toolchain,tools,vis)
9091
``--modules-footer=PATH`` |Path to file containing footer to be added to all generated module files
9192
``--modules-header=PATH`` |Path to file containing header to be added to all generated module files
9293
``--modules-tool=MODULES-TOOL`` |Modules tool to use (type choice; default: Lmod) (choices: EnvironmentModules, EnvironmentModulesC, EnvironmentModulesTcl, Lmod)
9394
``--package-naming-scheme=PACKAGE-NAMING-SCHEME`` |Packaging naming scheme choice (type choice; default: EasyBuildPNS) (choices: EasyBuildDebFriendlyPNS, EasyBuildPNS)
9495
``--packagepath=PACKAGEPATH`` |The destination path for the packages built by package-tool (default: /home/example/.local/easybuild/packages)
95-
``--prefix=PREFIX`` |Change prefix for buildpath, installpath, sourcepath and repositorypath (used prefix for defaults /home/example/.local/easybuild)
96+
``--prefix=PREFIX`` |Change prefix for buildpath, installpath, sourcepath, sourcepath-data, and repositorypath (used prefix for defaults /home/example/.local/easybuild)
9697
``--recursive-module-unload`` |Enable generating of modules that unload recursively. (default: False)
9798
``--repository=REPOSITORY`` |Repository type, using repositorypath (type choice; default: FileRepository) (choices: FileRepository, GitRepository)
9899
``--repositorypath=REPOSITORYPATH`` |Repository path, used by repository (is passed as list of arguments to create the repository instance). For more info, use --avail-repositories. (type comma-separated list; default: /home/example/.local/easybuild/ebfiles_repo)
99100
``--search-path-cpp-headers=SEARCH-PATH-CPP-HEADERS`` |Search path used at build time for include directories (type choice; default: flags) (choices: flags, cpath, include_paths)
100101
``--search-path-linker=SEARCH-PATH-LINKER`` |Search path used at build time by the linker for libraries (type choice; default: flags) (choices: flags, library_path)
101-
``--sourcepath=SOURCEPATH`` |Path(s) to where sources should be downloaded (string, colon-separated) (default: /home/example/.local/easybuild/sources)
102+
``--sourcepath=SOURCEPATH`` |Path(s) to where software sources should be downloaded (string, colon-separated) (default: /home/example/.local/easybuild/sources)
103+
``--sourcepath-data=SOURCEPATH-DATA`` |Path(s) to where data sources should be downloaded (string, colon-separated) (same as sourcepath if not specified)
104+
``--subdir-data=SUBDIR-DATA`` |Installpath subdir for data (default: data)
102105
``--subdir-modules=SUBDIR-MODULES`` |Installpath subdir for modules (default: modules)
103106
``--subdir-software=SUBDIR-SOFTWARE`` |Installpath subdir for software (default: software)
104107
``--subdir-user-modules=SUBDIR-USER-MODULES`` |Base path of user-specific modules relative to --envvars-user-modules
@@ -224,7 +227,7 @@ Option flag |Option description
224227
## Override options
225228

226229
Option flag |Option description
227-
-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
230+
-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
228231
``--accept-eula-for=ACCEPT-EULA-FOR`` |Accept EULA for specified software (type comma-separated list)
229232
``--add-system-to-minimal-toolchains`` |Include system toolchain in minimal toolchain searches (default: False)
230233
``--allow-loaded-modules=ALLOW-LOADED-MODULES`` |List of software names for which to allow loaded modules in initial environment (type comma-separated list; default: EasyBuild)
@@ -244,7 +247,11 @@ Option flag |Option
244247
``--copy-ec`` |Copy specified easyconfig(s) to specified location (default: False)
245248
``--cuda-cache-dir=PATH`` |Path to CUDA cache dir to use if enabled. Defaults to a path inside the build dir. (type <class 'str'>)
246249
``--cuda-cache-maxsize=CUDA-CACHE-MAXSIZE`` |Maximum size of the CUDA cache (in MiB) used for JIT compilation of PTX code. Leave value empty to let EasyBuild choose a value or '0' to disable the cache (type <class 'int'>)
247-
``--cuda-compute-capabilities=CUDA-COMPUTE-CAPABILITIES`` |List of CUDA compute capabilities to use when building GPU software; values should be specified as digits separated by a dot, for example: 3.5,5.0,7.2 (type comma-separated list)
250+
``--cuda-compute-capabilities=CUDA-COMPUTE-CAPABILITIES`` |List of CUDA compute capabilities to use when building GPU software; values should be specified as digits separated by a dot, for example: 3.5,5.0,7.2. EasyBuild will (where possible) compile fat binaries with support for (at least) all requested CUDA compute capabilities, and PTX code for the highest CUDA compute capability (for forwards compatibility). The check on this behavior may be relaxed using --cuda-sanity-check-accept-missing-ptx, --cuda-sanity-check-accept-ptx-as-devcode, or made more stringent using --cuda-sanity-check-strict. (type comma-separated list)
251+
``--cuda-sanity-check-accept-missing-ptx`` |Relax CUDA sanity check to accept that PTX code for the highest requested CUDA compute capability is not present (but will print a warning) (default: False)
252+
``--cuda-sanity-check-accept-ptx-as-devcode`` |Relax CUDA sanity check to accept that requested device code is not present, as long as PTX code is present that can be JIT-compiled for each target in --cuda-compute-capabilities. For example, if --cuda-compute-capabilities=8.0 and a binary is found in the installation that does not have device code for 8.0, but it does have PTX code for 7.0, the sanity check will pass if, and only if, this option is enabled. Note that JIT-compiling means the binary will work on the requested architecture, but is it not necessarily as well optimized as when actual device code is present for the requested architecture (default: False)
253+
``--cuda-sanity-check-error-on-failed-checks`` |If enabled, failures in the CUDA sanity check will produce an error. If disabled, the CUDA sanity check will be performed and failures will be reported through warnings, but they will not result in an error (default: False)
254+
``--cuda-sanity-check-strict`` |Perform strict CUDA sanity check. Without this option, the CUDA sanity check will fail if the CUDA binaries don't contain code for (at least) all compute capabilities defined in --cude-compute-capabilities, but will accept if code for additional compute capabilities is present. With this setting, the sanity check will also fail if code is present for more compute capabilities than defined in --cuda-compute-capabilities. (default: False)
248255
``--debug-lmod`` |Run Lmod modules tool commands in debug module (default: False)
249256
``--default-opt-level=DEFAULT-OPT-LEVEL`` |Specify default optimisation level (type choice; default: defaultopt) (choices: noopt, lowopt, defaultopt, opt)
250257
``--deprecated=DEPRECATED`` |Run pretending to be (future) version, to test removal of deprecated code.
@@ -317,7 +324,7 @@ Option flag |Option
317324
``--skip-test-step`` |Skip running the test step (e.g. unit tests) (default: False)
318325
``--software-commit=SOFTWARE-COMMIT`` |Git commit to use for the target software build (robot capabilities are automatically disabled)
319326
``--sticky-bit`` |Set sticky bit on newly created directories (default: False)
320-
``--strict-rpath-sanity-check`` |Perform strict RPATH sanity check, which involces unsetting $LD_LIBRARY_PATH before checking whether all required libraries are found (default: False)
327+
``--strict-rpath-sanity-check`` |Perform strict RPATH sanity check, which involves unsetting $LD_LIBRARY_PATH before checking whether all required libraries are found (default: False)
321328
``--sysroot=SYSROOT`` |Location root directory of system, prefix for standard paths like /usr/lib and /usr/include
322329
``-T, --trace`` |Provide more information in output to stdout on progress (default: True; disable with --disable-trace)
323330
``--umask=UMASK`` |umask to use (e.g. '022'); non-user write permissions on install directories are removed

0 commit comments

Comments
 (0)