Skip to content

auto-update docs for EasyBuild v5.2.0 #357

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.

Sign up for GitHub

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

Merged
bedroge merged 2 commits into from
Dec 23, 2025
Merged

auto-update docs for EasyBuild v5.2.0 #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
562f01d
auto-update docs for EasyBuild v5.2.0
boegel Dec 23, 2025
e593f9d
fix typo in description for build_env_vars easyconfig parameter of Bu…
boegel Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 11 additions & 2 deletions docs/version-specific/easyblocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,19 @@
- EB_MATLAB
- EB_MCR
- EB_MotionCor2
- EB_NVHPC
- EB_optiSLang
- EB_ORCA
- EB_Stata
- EB_Tornado
- NvidiaBase
- EB_NVHPC
- EB_nvidia_minus_compilers
- Rpm
- Bundle
- BuildEnv
- CrayToolchain
- EB_Clang_minus_AOMP
- EB_gnupg_minus_bundle
- EB_OpenSSL_wrapper
- JuliaBundle
- PerlBundle
Expand All @@ -55,6 +58,7 @@
- CMakeMakeCp
- EB_DualSPHysics
- CMakeNinja
- EB_pocl
- CMakePythonPackage
- EB_pybind11
- EB_Amber
Expand All @@ -67,6 +71,7 @@
- EB_GATE
- EB_Geant4
- EB_GROMACS
- EB_Kokkos
- EB_LAMMPS
- EB_Libint
- EB_LLVM
Expand Down Expand Up @@ -269,7 +274,9 @@
- EB_VTune
- MesonNinja
- CMakeNinja
- EB_pocl
- EB_Mesa
- EB_QEMU
- EB_scipy
- ModuleRC
- PackedBinary
Expand All @@ -286,11 +293,13 @@
- EB_MATLAB
- EB_MCR
- EB_MotionCor2
- EB_NVHPC
- EB_optiSLang
- EB_ORCA
- EB_Stata
- EB_Tornado
- NvidiaBase
- EB_NVHPC
- EB_nvidia_minus_compilers
- SCons
- EB_Xmipp
- Waf
Expand Down
2 changes: 1 addition & 1 deletion docs/version-specific/easyconfig-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
------------------------|----------------------------------------------------------------------------------------------------------|-----------------|--------------------
`exts_classmap` |Map of extension name to class for handling build and installation. |`{}` |`exts_class_map`
`exts_default_options` |List of default options for extensions |`{}` |`exts_default_opts`
`exts_defaultclass` |List of module for and name of the default extension class |`None` |`exts_default_class`
`exts_defaultclass` |Name of default easyblock for extensions |`None` |`exts_default_class`
`exts_download_dep_fail`|Fail if downloaded dependencies are detected for extensions |`False` |
`exts_filter` |Extension filter details: template for cmd and input to cmd (templates for ext_name, ext_version and src).|`None` |
`exts_list` |List with extensions added to the base installation |`[]` |
Expand Down
46 changes: 37 additions & 9 deletions docs/version-specific/easyconfig-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@

## Template names/values derived from easyconfig instance

Template name |Template value
---------------------------|-----------------------------
``%(module_name)s`` |Module name
``%(nameletter)s`` |First letter of software name
``%(toolchain_name)s`` |Toolchain name
``%(toolchain_version)s`` |Toolchain version
``%(version_major_minor)s``|Major.Minor version
``%(version_major)s`` |Major version
``%(version_minor)s`` |Minor version
Template name |Template value
---------------------------------|-----------------------------
``%(module_name)s`` |Module name
``%(nameletter)s`` |First letter of software name
``%(toolchain_name)s`` |Toolchain name
``%(toolchain_version)s`` |Toolchain version
``%(version_major_minor_patch)s``|Major.Minor.Patch version
``%(version_major_minor)s`` |Major.Minor version
``%(version_major)s`` |Major version
``%(version_minor_patch)s`` |Minor.Patch version
``%(version_minor)s`` |Minor version
``%(version_patch)s`` |Patch version

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

Expand Down Expand Up @@ -69,6 +72,7 @@ Template name |Template value
``%(amdgcn_cc_semicolon_sep)s`` |Semicolon-separated list of AMDGCN capabilities
``%(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+
``%(cuda_cc_nvhpc)s`` |List of CUDA compute capabilities suitable for use with -gpu option in NVHPC compilers
``%(cuda_cc_space_sep)s`` |Space-separated list of CUDA compute capabilities
``%(cuda_cc_space_sep_no_period)s``|Space-separated list of CUDA compute capabilities, without periods (e.g. '80 90').
``%(cuda_cc_semicolon_sep)s`` |Semicolon-separated list of CUDA compute capabilities
Expand Down Expand Up @@ -113,28 +117,52 @@ Constant |Template description
``SHLIB_EXT`` |extension for shared libraries |``dylib``
``SOURCE_TAR_GZ`` |Source .tar.gz bundle |``%(name)s-%(version)s.tar.gz``
``SOURCELOWER_TAR_GZ`` |Source .tar.gz bundle with lowercase name |``%(namelower)s-%(version)s.tar.gz``
``VERSION_TAR_GZ`` |Source filename <version>.tar.gz common at GitHub |``%(version)s.tar.gz``
``V_VERSION_TAR_GZ`` |Source filename v<version>.tar.gz common at GitHub |``v%(version)s.tar.gz``
``SOURCE_TAR_XZ`` |Source .tar.xz bundle |``%(name)s-%(version)s.tar.xz``
``SOURCELOWER_TAR_XZ`` |Source .tar.xz bundle with lowercase name |``%(namelower)s-%(version)s.tar.xz``
``VERSION_TAR_XZ`` |Source filename <version>.tar.xz common at GitHub |``%(version)s.tar.xz``
``V_VERSION_TAR_XZ`` |Source filename v<version>.tar.xz common at GitHub |``v%(version)s.tar.xz``
``SOURCE_TAR_BZ2`` |Source .tar.bz2 bundle |``%(name)s-%(version)s.tar.bz2``
``SOURCELOWER_TAR_BZ2`` |Source .tar.bz2 bundle with lowercase name |``%(namelower)s-%(version)s.tar.bz2``
``VERSION_TAR_BZ2`` |Source filename <version>.tar.bz2 common at GitHub |``%(version)s.tar.bz2``
``V_VERSION_TAR_BZ2`` |Source filename v<version>.tar.bz2 common at GitHub |``v%(version)s.tar.bz2``
``SOURCE_TGZ`` |Source .tgz bundle |``%(name)s-%(version)s.tgz``
``SOURCELOWER_TGZ`` |Source .tgz bundle with lowercase name |``%(namelower)s-%(version)s.tgz``
``VERSION_TGZ`` |Source filename <version>.tgz common at GitHub |``%(version)s.tgz``
``V_VERSION_TGZ`` |Source filename v<version>.tgz common at GitHub |``v%(version)s.tgz``
``SOURCE_TXZ`` |Source .txz bundle |``%(name)s-%(version)s.txz``
``SOURCELOWER_TXZ`` |Source .txz bundle with lowercase name |``%(namelower)s-%(version)s.txz``
``VERSION_TXZ`` |Source filename <version>.txz common at GitHub |``%(version)s.txz``
``V_VERSION_TXZ`` |Source filename v<version>.txz common at GitHub |``v%(version)s.txz``
``SOURCE_TBZ2`` |Source .tbz2 bundle |``%(name)s-%(version)s.tbz2``
``SOURCELOWER_TBZ2`` |Source .tbz2 bundle with lowercase name |``%(namelower)s-%(version)s.tbz2``
``VERSION_TBZ2`` |Source filename <version>.tbz2 common at GitHub |``%(version)s.tbz2``
``V_VERSION_TBZ2`` |Source filename v<version>.tbz2 common at GitHub |``v%(version)s.tbz2``
``SOURCE_TB2`` |Source .tb2 bundle |``%(name)s-%(version)s.tb2``
``SOURCELOWER_TB2`` |Source .tb2 bundle with lowercase name |``%(namelower)s-%(version)s.tb2``
``VERSION_TB2`` |Source filename <version>.tb2 common at GitHub |``%(version)s.tb2``
``V_VERSION_TB2`` |Source filename v<version>.tb2 common at GitHub |``v%(version)s.tb2``
``SOURCE_GTGZ`` |Source .gtgz bundle |``%(name)s-%(version)s.gtgz``
``SOURCELOWER_GTGZ`` |Source .gtgz bundle with lowercase name |``%(namelower)s-%(version)s.gtgz``
``VERSION_GTGZ`` |Source filename <version>.gtgz common at GitHub |``%(version)s.gtgz``
``V_VERSION_GTGZ`` |Source filename v<version>.gtgz common at GitHub |``v%(version)s.gtgz``
``SOURCE_ZIP`` |Source .zip bundle |``%(name)s-%(version)s.zip``
``SOURCELOWER_ZIP`` |Source .zip bundle with lowercase name |``%(namelower)s-%(version)s.zip``
``VERSION_ZIP`` |Source filename <version>.zip common at GitHub |``%(version)s.zip``
``V_VERSION_ZIP`` |Source filename v<version>.zip common at GitHub |``v%(version)s.zip``
``SOURCE_TAR`` |Source .tar bundle |``%(name)s-%(version)s.tar``
``SOURCELOWER_TAR`` |Source .tar bundle with lowercase name |``%(namelower)s-%(version)s.tar``
``VERSION_TAR`` |Source filename <version>.tar common at GitHub |``%(version)s.tar``
``V_VERSION_TAR`` |Source filename v<version>.tar common at GitHub |``v%(version)s.tar``
``SOURCE_XZ`` |Source .xz bundle |``%(name)s-%(version)s.xz``
``SOURCELOWER_XZ`` |Source .xz bundle with lowercase name |``%(namelower)s-%(version)s.xz``
``VERSION_XZ`` |Source filename <version>.xz common at GitHub |``%(version)s.xz``
``V_VERSION_XZ`` |Source filename v<version>.xz common at GitHub |``v%(version)s.xz``
``SOURCE_TAR_Z`` |Source .tar.Z bundle |``%(name)s-%(version)s.tar.Z``
``SOURCELOWER_TAR_Z`` |Source .tar.Z bundle with lowercase name |``%(namelower)s-%(version)s.tar.Z``
``VERSION_TAR_Z`` |Source filename <version>.tar.Z common at GitHub |``%(version)s.tar.Z``
``V_VERSION_TAR_Z`` |Source filename v<version>.tar.Z common at GitHub |``v%(version)s.tar.Z``
``SOURCE_WHL`` |Generic (non-compiled) Python 2 & Python 3 wheel package |``%(name)s-%(version)s-py2.py3-none-any.whl``
``SOURCELOWER_WHL`` |Generic (non-compiled) Python 2 & Python 3 wheel package with lowercase name |``%(namelower)s-%(version)s-py2.py3-none-any.whl``
``SOURCE_PY2_WHL`` |Generic (non-compiled) Python 2 wheel package |``%(name)s-%(version)s-py2-none-any.whl``
Expand Down
3 changes: 2 additions & 1 deletion docs/version-specific/eb-help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Option flag |Option description
## GitHub integration options

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