From d3a6bf0cb61e20f2d0cd9dd7d0e39a30be3c778d Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Tue, 4 Apr 2023 09:15:28 +0100 Subject: [PATCH 1/3] only list requirements once --- docs/installation.md | 44 +++++++++++++++----------------------------- 1 file changed, 15 insertions(+), 29 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 2e86c875d..8a592d5f5 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -16,20 +16,21 @@ Notes on other ways of installing EasyBuild are available under section [Alterna The only strict requirements are: -* a **GNU/Linux distribution** as operating system -* **Python**: - * Python 2.7, or Python 3.x (>= 3.5). Since [Python 2 is end-of-life](https://www.python.org/doc/sunset-python-2/) we recommend - using Python 3 if it is available - * **note**: only EasyBuild v4.0 (or newer) is compatible with Python 3, earlier EasyBuild releases require Python 2 - * no Python packages other than the ones included in the Python standard library are strictly required - * **note**: only EasyBuild versions prior to v4.0 require `vsc-base` (& `vsc-install`), - see also [Required Python packages for older EasyBuild versions][required_python_packages_eb3] - * for some specific features, additional Python packages are needed though, see [Optional Python packages][optional_python_packages] +* a **GNU/Linux** distribution as operating system + * some common shell tools are expected to be available, see [Required shell tools][required_shell_tools] +* [Python](https://python.org): + * Python 2.7, or Python 3.x (>= 3.5); + * since [Python 2 is end-of-life](https://www.python.org/doc/sunset-python-2/) we strongly recommend + using Python 3 if it is available; + * EasyBuild 5.0 will require Python >= 3.6; + * no third-party Python packages are strictly required (the Python standard library is sufficient); + * for some *specific* EasyBuild features additional Python packages are required however, see [Optional Python packages][optional_python_packages]; * a **modules tool**: Tcl(/C) environment modules or Lmod - * the actual module command/script (`modulecmd`, `modulecmd.tcl` or `lmod`) *must* be available via `$PATH` - * see [Required modules tool][required_modules_tool] for more details + * the actual modules tool *must* be available via `$PATH`, see [Required modules tool][required_modules_tool] +* a C/C++ compiler (e.g., `gcc` and `g++`) + * only required to build and install GCC with, or as a dependency for the Intel compilers, for example -For more information on (optional) dependencies, see [Dependencies][dependencies]. +For more information on dependencies, see [Dependencies][dependencies]. ## Using pip to Install EasyBuild {: #pip } @@ -307,23 +308,8 @@ module load EasyBuild ## Dependencies {: #dependencies } -EasyBuild has a couple of dependencies, some are optional. - - -### Required dependencies {: #required_dependencies } - -* a **GNU/Linux** distribution as operating system - * some common shell tools are expected to be available, see [Required shell tools][required_shell_tools] -* [Python](https://python.org): - * Python 2.7, or Python 3.x (>= 3.5); - * since [Python 2 is end-of-life](https://www.python.org/doc/sunset-python-2/) we strongly recommend - using Python 3 if it is available; - * no third-party Python packages are strictly required (the Python standard library is sufficient); - * for some *specific* EasyBuild features additional Python packages are required however, see [Optional Python packages][optional_python_packages]; -* a **modules tool**: Tcl(/C) environment modules or Lmod - * the actual modules tool *must* be available via `$PATH`, see [Required modules tool][required_modules_tool] -* a C/C++ compiler (e.g., `gcc` and `g++`) - * only required to build and install GCC with, or as a dependency for the Intel compilers, for example +EasyBuild has a some [required dependencies][requirements] and some optional ones. This section gives additional +information on the dependencies. #### Required shell tools {: #required_shell_tools } From 8060835943a59cf8c6e5763f6a9f956ab2e4159b Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Tue, 4 Apr 2023 09:19:47 +0100 Subject: [PATCH 2/3] fix header levels --- docs/installation.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 8a592d5f5..8a6b6dfbc 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -306,13 +306,12 @@ module load EasyBuild The environment module file that was generated by EasyBuild specifies all changes that need to be made. -## Dependencies {: #dependencies } +## Required Dependencies {: #dependencies } -EasyBuild has a some [required dependencies][requirements] and some optional ones. This section gives additional -information on the dependencies. +This section gives further information on the [required dependencies][requirements]. -#### Required shell tools {: #required_shell_tools } +### Required shell tools {: #required_shell_tools } @@ -330,7 +329,7 @@ A couple of shell tools may be required, depending on the particular use case (i * `sysctl`, for querying system characteristics (only required on non-Linux systems) -#### Required modules tool {: #required_modules_tool } +### Required modules tool {: #required_modules_tool } EasyBuild not only generates module files to be used along with the software it installs, it also depends on the generated modules, mainly for resolving dependencies. @@ -376,12 +375,12 @@ Additional notes: [Installing Lmod without root permissions][installing_lmod]. -#### Required Python packages {: #required_python_packages } +### Required Python packages {: #required_python_packages } Since EasyBuild v4.0, *no* Python packages outside of the Python standard library are required. -##### Required Python packages for older EasyBuild versions {: #required_python_packages_eb3 } +#### Required Python packages for older EasyBuild versions {: #required_python_packages_eb3 } For EasyBuild versions prior to version 4.0, a couple of additional Python packages are required: @@ -404,12 +403,12 @@ For EasyBuild versions prior to version 4.0, a couple of additional Python packa Other Python packages are optional dependencies, see [Optional Python packages][optional_python_packages]. -### Optional dependencies +## Optional dependencies Some dependencies are optional and are only required to support certain features. -#### Optional Python packages {: #optional_python_packages } +### Optional Python packages {: #optional_python_packages } * [GC3Pie](https://pypi.org/project/gc3pie), only needed when using `GC3Pie` as a backend for `--job`, see also [Submitting jobs using --job][submitting_jobs]; From 0c263487ed816cebade4c1fbd0d2206c05864cec Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 12 Apr 2023 14:29:01 +0200 Subject: [PATCH 3/3] add ; --- docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index cecf65721..1256857db 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -22,7 +22,7 @@ The only strict requirements are: * Python 2.7, or Python 3.x (>= 3.5); * since [Python 2 is end-of-life](https://www.python.org/doc/sunset-python-2/) we strongly recommend using Python 3 if it is available; - * only EasyBuild v4.0 (or newer) is compatible with Python 3, earlier EasyBuild releases require Python 2 + * only EasyBuild v4.0 (or newer) is compatible with Python 3, earlier EasyBuild releases require Python 2; * EasyBuild 5.0 will require Python >= 3.6; * no third-party Python packages are strictly required (the Python standard library is sufficient); * for some *specific* EasyBuild features additional Python packages are required however, see [Optional Python packages][optional_python_packages];