Skip to content
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

auto-update docs for EasyBuild v4.7.1 #127

Merged
merged 1 commit into from
Mar 20, 2023
+1,712 −557
Merged

auto-update docs for EasyBuild v4.7.1 #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/version-specific/easyblocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@
- EB_python_minus_meep
- EB_PyTorch
- EB_PyZMQ
- EB_scipy
- EB_SEPP
- EB_TensorFlow
- EB_TensorRT
Expand Down Expand Up @@ -314,6 +315,7 @@
- MesonNinja
- CMakeNinja
- EB_Mesa
- EB_scipy
- ModuleRC
- PackedBinary
- EB_ANSYS
Expand Down Expand Up @@ -367,6 +369,7 @@
- EB_python_minus_meep
- EB_PyTorch
- EB_PyZMQ
- EB_scipy
- EB_SEPP
- EB_TensorFlow
- EB_TensorRT
Expand Down
23 changes: 12 additions & 11 deletions docs/version-specific/easyconfig-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
`required_linked_shared_libs`|List of shared libraries (names, file names, or paths) which must be linked in all installed binaries/libraries |`[]`
`runtest` |Indicates if a test should be run after make; should specify argument after make (for e.g.,"test" for make test) |`None`
`sanity_check_commands` |format: [(name, options)] e.g. [('gzip','-h')]. Using a non-tuple is equivalent to (name, '-h') |`[]`
`sanity_check_paths` |List of files and directories to check (format: {'files':<list>, 'dirs':<list>}) |`{}`
`sanity_check_paths` |List of files and directories to check (format: {'files':<list>, 'dirs':<list>}) |`{}`
`skip` |Skip existing software |`False`
`skipsteps` |Skip these steps |`[]`
`source_urls` |List of URLs for source files |`[]`
Expand All @@ -81,16 +81,16 @@

## Dependencies parameters

**Parameter name** |**Description** |**Default value**
-------------------------|---------------------------------------------------------------------|-----------------
`allow_system_deps` |Allow listed system dependencies (format: (<name>, <version>)) |`[]`
`builddependencies` |List of build dependencies |`[]`
`dependencies` |List of dependencies |`[]`
`hiddendependencies` |List of dependencies available as hidden modules |`[]`
`moddependpaths` |Absolute path(s) to prepend to MODULEPATH before loading dependencies|`None`
`multi_deps` |Dict of lists of dependency versions over which to iterate |`{}`
`multi_deps_load_default`|Load module for first version listed in multi_deps by default |`True`
`osdependencies` |OS dependencies that should be present on the system |`[]`
**Parameter name** |**Description** |**Default value**
-------------------------|--------------------------------------------------------------------------|-----------------
`allow_system_deps` |Allow listed system dependencies (format: (<name>, <version>))|`[]`
`builddependencies` |List of build dependencies |`[]`
`dependencies` |List of dependencies |`[]`
`hiddendependencies` |List of dependencies available as hidden modules |`[]`
`moddependpaths` |Absolute path(s) to prepend to MODULEPATH before loading dependencies |`None`
`multi_deps` |Dict of lists of dependency versions over which to iterate |`{}`
`multi_deps_load_default`|Load module for first version listed in multi_deps by default |`True`
`osdependencies` |OS dependencies that should be present on the system |`[]`

## License parameters

Expand Down Expand Up @@ -134,6 +134,7 @@
`moduleclass` |Module class to be used for this software |`"base"`
`moduleforceunload` |Force unload of all modules when loading the extension |`False`
`moduleloadnoconflict` |Don't check for conflicts, unload other versions instead |`False`
`modunloadmsg` |Message that should be printed when generated module is unloaded |`{}`
`recursive_module_unload` |Recursive unload of all dependencies when unloading module (True/False to hard enable/disable; None implies honoring the --recursive-module-unload EasyBuild configuration setting|`None`
`site_contacts` |String/list of strings with site contacts for the software |`None`
`upstream_contacts` |String/list of strings with upstream contact addresses (e.g., support e-mail, mailing list, bugtracker) |`None`
Expand Down
3 changes: 2 additions & 1 deletion docs/version-specific/easyconfig-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,10 @@ Template name |Template value
## Template values set outside EasyBlock runstep

Template name |Template value
------------------|----------------------
------------------|-------------------------------------------
``%(builddir)s`` |Build directory
``%(installdir)s``|Installation directory
``%(start_dir)s`` |Directory in which the build process begins

## Template values which are defined dynamically

Expand Down
26 changes: 13 additions & 13 deletions docs/version-specific/eb-help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Option flag |Option description
## Configfile options

Option flag |Option description
-----------------------------------------|---------------------------------------------------------------------
``--configfiles=CONFIGFILES`` |Parse (additional) configfiles (type comma-separated list; default: )
-----------------------------------------|----------------------------------------------------------
``--configfiles=CONFIGFILES`` |Parse (additional) configfiles (type comma-separated list)
``--ignoreconfigfiles=IGNORECONFIGFILES``|Ignore configfiles (type comma-separated list)

## Basic options
Expand All @@ -51,9 +51,9 @@ Option flag |Option description
``-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; default: )
``-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; default: )
``--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)
Expand All @@ -71,9 +71,9 @@ Option flag |Option descrip
``--external-modules-metadata=EXTERNAL-MODULES-METADATA`` |List of (glob patterns for) paths to files specifying metadata for external modules (INI format) (type comma-separated list)
``--hooks=HOOKS`` |Location of Python module with hook implementations (type str)
``--ignore-dirs=IGNORE-DIRS`` |Directory names to ignore when searching for files/dirs (type comma-separated list; default: .git,.svn)
``--include-easyblocks=INCLUDE-EASYBLOCKS`` |Location(s) of extra or customized easyblocks (type comma-separated list; default: )
``--include-module-naming-schemes=INCLUDE-MODULE-NAMING-SCHEMES``|Location(s) of extra or customized module naming schemes (type comma-separated list; default: )
``--include-toolchains=INCLUDE-TOOLCHAINS`` |Location(s) of extra or customized toolchains or toolchain components (type comma-separated list; default: )
``--include-easyblocks=INCLUDE-EASYBLOCKS`` |Location(s) of extra or customized easyblocks (type comma-separated list)
``--include-module-naming-schemes=INCLUDE-MODULE-NAMING-SCHEMES``|Location(s) of extra or customized module naming schemes (type comma-separated list)
``--include-toolchains=INCLUDE-TOOLCHAINS`` |Location(s) of extra or customized toolchains or toolchain components (type comma-separated list)
``--installpath=INSTALLPATH`` |Install path for software and modules (default: /home/example/.local/easybuild)
``--installpath-modules=INSTALLPATH-MODULES`` |Install path for modules (if None, combine --installpath and --subdir-modules)
``--installpath-software=INSTALLPATH-SOFTWARE`` |Install path for software (if None, combine --installpath and --subdir-software)
Expand All @@ -87,7 +87,7 @@ Option flag |Option descrip
``--modules-footer=PATH`` |Path to file containing footer to be added to all generated module files
``--modules-header=PATH`` |Path to file containing header to be added to all generated module files
``--modules-tool=MODULES-TOOL`` |Modules tool to use (type choice; default: Lmod) (choices: EnvironmentModules, EnvironmentModulesC, EnvironmentModulesTcl, Lmod)
``--package-naming-scheme=PACKAGE-NAMING-SCHEME`` |Packaging naming scheme choice (type choice; default: EasyBuildPNS) (choices: EasyBuildPNS)
``--package-naming-scheme=PACKAGE-NAMING-SCHEME`` |Packaging naming scheme choice (type choice; default: EasyBuildPNS) (choices: EasyBuildDebFriendlyPNS, EasyBuildPNS)
``--packagepath=PACKAGEPATH`` |The destination path for the packages built by package-tool (default: /home/example/.local/easybuild/packages)
``--prefix=PREFIX`` |Change prefix for buildpath, installpath, sourcepath and repositorypath (used prefix for defaults /home/example/.local/easybuild)
``--recursive-module-unload`` |Enable generating of modules that unload recursively. (default: False)
Expand Down Expand Up @@ -139,11 +139,11 @@ Option flag |Option description
``--close-pr-msg=CLOSE-PR-MSG`` |Custom close message for pull request closed with --close-pr; (type <class 'str'>)
``--close-pr-reasons=CLOSE-PR-REASONS`` |Close reason for pull request closed with --close-pr; supported values: archived, inactive, obsolete, retest (type <class 'str'>)
``--dump-test-report=DUMP-TEST-REPORT`` |Dump test report to specified path (default: test_report.md)
``--from-pr=PR#`` |Obtain easyconfigs from specified PR (type comma-separated list; default: )
``--from-pr=PR#`` |Obtain easyconfigs from specified PR (type comma-separated list)
``--git-working-dirs-path=GIT-WORKING-DIRS-PATH`` |Path to Git working directories for EasyBuild repositories (type <class 'str'>)
``--github-org=GITHUB-ORG`` |GitHub organization (type <class 'str'>)
``--github-user=GITHUB-USER`` |GitHub username (type <class 'str'>)
``--include-easyblocks-from-pr=PR#`` |Include easyblocks from specified PR (type comma-separated list; default: )
``--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)
``--list-prs=STATE,ORDER,DIRECTION`` |List pull requests (type <class 'str'>; default: open,created,desc)
``--merge-pr=PR#`` |Merge pull request (type <class 'int'>)
Expand Down Expand Up @@ -218,8 +218,8 @@ Option flag |Option description

Option flag |Option description
-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
``--accept-eula=ACCEPT-EULA`` |Accept EULA for specified software [DEPRECATED, use --accept-eula-for instead!] (type comma-separated list; default: )
``--accept-eula-for=ACCEPT-EULA-FOR`` |Accept EULA for specified software (type comma-separated list; default: )
``--accept-eula=ACCEPT-EULA`` |Accept EULA for specified software [DEPRECATED, use --accept-eula-for instead!] (type comma-separated list)
``--accept-eula-for=ACCEPT-EULA-FOR`` |Accept EULA for specified software (type comma-separated list)
``--add-dummy-to-minimal-toolchains`` |Include dummy toolchain in minimal toolchain searches [DEPRECATED, use --add-system-to-minimal-toolchains instead!] (default: False)
``--add-system-to-minimal-toolchains`` |Include system toolchain in minimal toolchain searches (default: False)
``--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)
Expand Down Expand Up @@ -297,7 +297,7 @@ Option flag |Option
``--set-default-module`` |Set the generated module as default (default: False)
``--set-gid-bit`` |Set group ID bit on newly created directories (default: False)
``--show-progress-bar`` |Show progress bar in terminal output (default: True; disable with --disable-show-progress-bar)
``--silence-deprecation-warnings=SILENCE-DEPRECATION-WARNINGS`` |Silence specified deprecation warnings (type comma-separated list)
``--silence-deprecation-warnings=SILENCE-DEPRECATION-WARNINGS`` |Silence specified deprecation warnings out of (python2, Lmod6, easyconfig, toolchain) (type comma-separated list)
``--skip-extensions`` |Skip installation of extensions (default: False)
``-t, --skip-test-cases`` |Skip running test cases (default: False)
``--skip-test-step`` |Skip running the test step (e.g. unit tests) (default: False)
Expand Down
Loading