Skip to content

Commit fe293de

Browse files
bedrogebedroge
authored
Merge pull request #357 from boegel/eb520_auto_update
auto-update docs for EasyBuild v5.2.0
2 parents 96efe9b + e593f9d commit fe293de

File tree

905 files changed

+5019
-318
lines changed

Some content is hidden

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

905 files changed

+5019
-318
lines changed

‎docs/version-specific/easyblocks.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,19 @@
3131
- EB_MATLAB
3232
- EB_MCR
3333
- EB_MotionCor2
34-
- EB_NVHPC
3534
- EB_optiSLang
3635
- EB_ORCA
3736
- EB_Stata
3837
- EB_Tornado
38+
- NvidiaBase
39+
- EB_NVHPC
40+
- EB_nvidia_minus_compilers
3941
- Rpm
4042
- Bundle
4143
- BuildEnv
4244
- CrayToolchain
4345
- EB_Clang_minus_AOMP
46+
- EB_gnupg_minus_bundle
4447
- EB_OpenSSL_wrapper
4548
- JuliaBundle
4649
- PerlBundle
@@ -55,6 +58,7 @@
5558
- CMakeMakeCp
5659
- EB_DualSPHysics
5760
- CMakeNinja
61+
- EB_pocl
5862
- CMakePythonPackage
5963
- EB_pybind11
6064
- EB_Amber
@@ -67,6 +71,7 @@
6771
- EB_GATE
6872
- EB_Geant4
6973
- EB_GROMACS
74+
- EB_Kokkos
7075
- EB_LAMMPS
7176
- EB_Libint
7277
- EB_LLVM
@@ -269,7 +274,9 @@
269274
- EB_VTune
270275
- MesonNinja
271276
- CMakeNinja
277+
- EB_pocl
272278
- EB_Mesa
279+
- EB_QEMU
273280
- EB_scipy
274281
- ModuleRC
275282
- PackedBinary
@@ -286,11 +293,13 @@
286293
- EB_MATLAB
287294
- EB_MCR
288295
- EB_MotionCor2
289-
- EB_NVHPC
290296
- EB_optiSLang
291297
- EB_ORCA
292298
- EB_Stata
293299
- EB_Tornado
300+
- NvidiaBase
301+
- EB_NVHPC
302+
- EB_nvidia_minus_compilers
294303
- SCons
295304
- EB_Xmipp
296305
- Waf

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
------------------------|----------------------------------------------------------------------------------------------------------|-----------------|--------------------
114114
`exts_classmap` |Map of extension name to class for handling build and installation. |`{}` |`exts_class_map`
115115
`exts_default_options` |List of default options for extensions |`{}` |`exts_default_opts`
116-
`exts_defaultclass` |List of module for and name of the default extension class |`None` |`exts_default_class`
116+
`exts_defaultclass` |Name of default easyblock for extensions |`None` |`exts_default_class`
117117
`exts_download_dep_fail`|Fail if downloaded dependencies are detected for extensions |`False` |
118118
`exts_filter` |Extension filter details: template for cmd and input to cmd (templates for ext_name, ext_version and src).|`None` |
119119
`exts_list` |List with extensions added to the base installation |`[]` |

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

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22

33
## Template names/values derived from easyconfig instance
44

5-
Template name |Template value
6-
---------------------------|-----------------------------
7-
``%(module_name)s`` |Module name
8-
``%(nameletter)s`` |First letter of software name
9-
``%(toolchain_name)s`` |Toolchain name
10-
``%(toolchain_version)s`` |Toolchain version
11-
``%(version_major_minor)s``|Major.Minor version
12-
``%(version_major)s`` |Major version
13-
``%(version_minor)s`` |Minor version
5+
Template name |Template value
6+
---------------------------------|-----------------------------
7+
``%(module_name)s`` |Module name
8+
``%(nameletter)s`` |First letter of software name
9+
``%(toolchain_name)s`` |Toolchain name
10+
``%(toolchain_version)s`` |Toolchain version
11+
``%(version_major_minor_patch)s``|Major.Minor.Patch version
12+
``%(version_major_minor)s`` |Major.Minor version
13+
``%(version_major)s`` |Major version
14+
``%(version_minor_patch)s`` |Minor.Patch version
15+
``%(version_minor)s`` |Minor version
16+
``%(version_patch)s`` |Patch version
1417

1518
## Template names/values for (short) software versions
1619

@@ -69,6 +72,7 @@ Template name |Template value
6972
``%(amdgcn_cc_semicolon_sep)s`` |Semicolon-separated list of AMDGCN capabilities
7073
``%(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
7174
``%(cuda_cc_cmake)s`` |List of CUDA compute capabilities suitable for use with $CUDAARCHS in CMake 3.18+
75+
``%(cuda_cc_nvhpc)s`` |List of CUDA compute capabilities suitable for use with -gpu option in NVHPC compilers
7276
``%(cuda_cc_space_sep)s`` |Space-separated list of CUDA compute capabilities
7377
``%(cuda_cc_space_sep_no_period)s``|Space-separated list of CUDA compute capabilities, without periods (e.g. '80 90').
7478
``%(cuda_cc_semicolon_sep)s`` |Semicolon-separated list of CUDA compute capabilities
@@ -113,28 +117,52 @@ Constant |Template description
113117
``SHLIB_EXT`` |extension for shared libraries |``dylib``
114118
``SOURCE_TAR_GZ`` |Source .tar.gz bundle |``%(name)s-%(version)s.tar.gz``
115119
``SOURCELOWER_TAR_GZ`` |Source .tar.gz bundle with lowercase name |``%(namelower)s-%(version)s.tar.gz``
120+
``VERSION_TAR_GZ`` |Source filename <version>.tar.gz common at GitHub |``%(version)s.tar.gz``
121+
``V_VERSION_TAR_GZ`` |Source filename v<version>.tar.gz common at GitHub |``v%(version)s.tar.gz``
116122
``SOURCE_TAR_XZ`` |Source .tar.xz bundle |``%(name)s-%(version)s.tar.xz``
117123
``SOURCELOWER_TAR_XZ`` |Source .tar.xz bundle with lowercase name |``%(namelower)s-%(version)s.tar.xz``
124+
``VERSION_TAR_XZ`` |Source filename <version>.tar.xz common at GitHub |``%(version)s.tar.xz``
125+
``V_VERSION_TAR_XZ`` |Source filename v<version>.tar.xz common at GitHub |``v%(version)s.tar.xz``
118126
``SOURCE_TAR_BZ2`` |Source .tar.bz2 bundle |``%(name)s-%(version)s.tar.bz2``
119127
``SOURCELOWER_TAR_BZ2`` |Source .tar.bz2 bundle with lowercase name |``%(namelower)s-%(version)s.tar.bz2``
128+
``VERSION_TAR_BZ2`` |Source filename <version>.tar.bz2 common at GitHub |``%(version)s.tar.bz2``
129+
``V_VERSION_TAR_BZ2`` |Source filename v<version>.tar.bz2 common at GitHub |``v%(version)s.tar.bz2``
120130
``SOURCE_TGZ`` |Source .tgz bundle |``%(name)s-%(version)s.tgz``
121131
``SOURCELOWER_TGZ`` |Source .tgz bundle with lowercase name |``%(namelower)s-%(version)s.tgz``
132+
``VERSION_TGZ`` |Source filename <version>.tgz common at GitHub |``%(version)s.tgz``
133+
``V_VERSION_TGZ`` |Source filename v<version>.tgz common at GitHub |``v%(version)s.tgz``
122134
``SOURCE_TXZ`` |Source .txz bundle |``%(name)s-%(version)s.txz``
123135
``SOURCELOWER_TXZ`` |Source .txz bundle with lowercase name |``%(namelower)s-%(version)s.txz``
136+
``VERSION_TXZ`` |Source filename <version>.txz common at GitHub |``%(version)s.txz``
137+
``V_VERSION_TXZ`` |Source filename v<version>.txz common at GitHub |``v%(version)s.txz``
124138
``SOURCE_TBZ2`` |Source .tbz2 bundle |``%(name)s-%(version)s.tbz2``
125139
``SOURCELOWER_TBZ2`` |Source .tbz2 bundle with lowercase name |``%(namelower)s-%(version)s.tbz2``
140+
``VERSION_TBZ2`` |Source filename <version>.tbz2 common at GitHub |``%(version)s.tbz2``
141+
``V_VERSION_TBZ2`` |Source filename v<version>.tbz2 common at GitHub |``v%(version)s.tbz2``
126142
``SOURCE_TB2`` |Source .tb2 bundle |``%(name)s-%(version)s.tb2``
127143
``SOURCELOWER_TB2`` |Source .tb2 bundle with lowercase name |``%(namelower)s-%(version)s.tb2``
144+
``VERSION_TB2`` |Source filename <version>.tb2 common at GitHub |``%(version)s.tb2``
145+
``V_VERSION_TB2`` |Source filename v<version>.tb2 common at GitHub |``v%(version)s.tb2``
128146
``SOURCE_GTGZ`` |Source .gtgz bundle |``%(name)s-%(version)s.gtgz``
129147
``SOURCELOWER_GTGZ`` |Source .gtgz bundle with lowercase name |``%(namelower)s-%(version)s.gtgz``
148+
``VERSION_GTGZ`` |Source filename <version>.gtgz common at GitHub |``%(version)s.gtgz``
149+
``V_VERSION_GTGZ`` |Source filename v<version>.gtgz common at GitHub |``v%(version)s.gtgz``
130150
``SOURCE_ZIP`` |Source .zip bundle |``%(name)s-%(version)s.zip``
131151
``SOURCELOWER_ZIP`` |Source .zip bundle with lowercase name |``%(namelower)s-%(version)s.zip``
152+
``VERSION_ZIP`` |Source filename <version>.zip common at GitHub |``%(version)s.zip``
153+
``V_VERSION_ZIP`` |Source filename v<version>.zip common at GitHub |``v%(version)s.zip``
132154
``SOURCE_TAR`` |Source .tar bundle |``%(name)s-%(version)s.tar``
133155
``SOURCELOWER_TAR`` |Source .tar bundle with lowercase name |``%(namelower)s-%(version)s.tar``
156+
``VERSION_TAR`` |Source filename <version>.tar common at GitHub |``%(version)s.tar``
157+
``V_VERSION_TAR`` |Source filename v<version>.tar common at GitHub |``v%(version)s.tar``
134158
``SOURCE_XZ`` |Source .xz bundle |``%(name)s-%(version)s.xz``
135159
``SOURCELOWER_XZ`` |Source .xz bundle with lowercase name |``%(namelower)s-%(version)s.xz``
160+
``VERSION_XZ`` |Source filename <version>.xz common at GitHub |``%(version)s.xz``
161+
``V_VERSION_XZ`` |Source filename v<version>.xz common at GitHub |``v%(version)s.xz``
136162
``SOURCE_TAR_Z`` |Source .tar.Z bundle |``%(name)s-%(version)s.tar.Z``
137163
``SOURCELOWER_TAR_Z`` |Source .tar.Z bundle with lowercase name |``%(namelower)s-%(version)s.tar.Z``
164+
``VERSION_TAR_Z`` |Source filename <version>.tar.Z common at GitHub |``%(version)s.tar.Z``
165+
``V_VERSION_TAR_Z`` |Source filename v<version>.tar.Z common at GitHub |``v%(version)s.tar.Z``
138166
``SOURCE_WHL`` |Generic (non-compiled) Python 2 & Python 3 wheel package |``%(name)s-%(version)s-py2.py3-none-any.whl``
139167
``SOURCELOWER_WHL`` |Generic (non-compiled) Python 2 & Python 3 wheel package with lowercase name |``%(namelower)s-%(version)s-py2.py3-none-any.whl``
140168
``SOURCE_PY2_WHL`` |Generic (non-compiled) Python 2 wheel package |``%(name)s-%(version)s-py2-none-any.whl``

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Option flag |Option description
137137
## GitHub integration options
138138

139139
Option flag |Option description
140-
-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------
140+
-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------
141141
``--add-pr-labels=PR#`` |Try to add labels to PR based on files changed (type <class 'int'>)
142142
``--check-contrib`` |Runs checks to see whether the given easyconfigs are ready to be contributed back (default: False)
143143
``--check-github`` |Check status of GitHub integration, and report back (default: False)
@@ -155,6 +155,7 @@ Option flag |Option description
155155
``--include-easyblocks-from-commit=commit_SHA`` |Include easyblocks from specified commit (type str)
156156
``--include-easyblocks-from-pr=PR#`` |Include easyblocks from specified PR (type comma-separated list)
157157
``--install-github-token`` |Install GitHub token (requires --github-user) (default: False)
158+
``--keep-going`` |Continue installation of remaining software after a failed installation. Implied by --dump-test-report and --upload-test-report (default: False)
158159
``--list-prs=STATE,ORDER,DIRECTION`` |List pull requests (type <class 'str'>; default: open,created,desc)
159160
``--merge-pr=PR#`` |Merge pull request (type <class 'int'>)
160161
``--new-branch-github`` |Create new branch in GitHub in preparation for a PR (default: False)

0 commit comments

Comments
 (0)