Skip to content

Commit a2bb8d9

Browse files
authored
update installation page for EB5
1 parent 63da3b6 commit a2bb8d9

File tree

1 file changed

+19
-42
lines changed

1 file changed

+19
-42
lines changed

docs/installation.md

Lines changed: 19 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ The only strict requirements are:
1919
* a **GNU/Linux** distribution as operating system
2020
* some common shell tools are expected to be available, see [Required shell tools][required_shell_tools]
2121
* [Python](https://python.org):
22-
* Python 2.7, or Python 3.x (>= 3.5);
23-
* since [Python 2 is end-of-life](https://www.python.org/doc/sunset-python-2/) we strongly recommend
24-
using Python 3 if it is available;
25-
* only EasyBuild v4.0 (or newer) is compatible with Python 3, earlier EasyBuild releases require Python 2;
26-
* EasyBuild 5.0 will require Python >= 3.6;
22+
* Python >= 3.6 is required for EasyBuild 5.0;
2723
* no third-party Python packages are strictly required (the Python standard library is sufficient);
2824
* for some *specific* EasyBuild features additional Python packages are required however, see [Optional Python packages][optional_python_packages];
2925
* a **modules tool**: Tcl(/C) environment modules or Lmod
@@ -58,23 +54,10 @@ Compare the version of `eb`, the main EasyBuild command, with the version of the
5854
For example::
5955

6056
``` console
61-
$ module load EasyBuild
62-
$ module list
63-
64-
Currently Loaded Modules:
65-
1) EasyBuild/4.8.0
66-
6757
$ eb --version
68-
This is EasyBuild 4.8.0 (framework: 4.8.0, easyblocks: 4.8.0) on host example.local
58+
This is EasyBuild 5.0.0 (framework: 5.0.0, easyblocks: 5.0.0) on host example.local
6959
```
7060

71-
!!! tip
72-
The Tcl/C Environment Modules (version <= 3.2.10) does its default sorting differently than
73-
newer versions of Environment Modules and Lmod. The former will normally sort in the
74-
lexicographic order, while the latters follow an approach that is closer to Python's construct
75-
`LooseVersion` way of ordering. Such aspects may make a big difference, if you have installed
76-
both versions 1.9.0 and 1.15.2, with respect to what is the version being loaded by default.
77-
7861
You can also run `eb --show-system-info` to see system information relevant to EasyBuild,
7962
or run`eb --show-config` to see the default EasyBuild configuration (see also [Configuring EasyBuild][configuring_easybuild]).
8063

@@ -90,12 +73,6 @@ To upgrade to a newer EasyBuild version than the one currently installed:
9073

9174
For the `pip` install, you may wish to slightly change this command depending on the context and your personal preferences:
9275

93-
* to install EasyBuild *system-wide*, you can use `sudo` (if you have admin privileges):
94-
95-
``` shell
96-
sudo pip install easybuild
97-
```
98-
9976
* To install EasyBuild *in your personal home directory*, you can use the `--user` option:
10077

10178
``` shell
@@ -131,7 +108,7 @@ above:
131108
pip3 install easybuild
132109
```
133110

134-
If you want to ensure that you are using the `pip` installation that corresponds to the Python 3 installation
111+
If you want to ensure that you are using the `pip` installation that corresponds a specific Python installation
135112
that you intend to use, you can use `python3 -m pip` rather than `pip3`.
136113

137114
``` shell
@@ -225,10 +202,10 @@ you can define the `$EB_VERBOSE` environment variable. For example:
225202
``` console
226203
$ EB_VERBOSE=1 eb --version
227204
>> Considering 'python3.6'...
228-
>> 'python3' version: 3.6.8, which matches Python 3 version requirement (>= 3.5)
205+
>> 'python3' version: 3.6.8, which matches Python 3 version requirement (>= 3.6)
229206
>> Selected Python command: python3 (/usr/bin/python3.6)
230207
>> python3.6 -m easybuild.main --version
231-
This is EasyBuild 4.8.0 (framework: 4.8.0, easyblocks: 4.8.0) on host example
208+
This is EasyBuild 5.0.0 (framework: 5.0.0, easyblocks: 5.0.0) on host example
232209
```
233210

234211

@@ -299,7 +276,14 @@ module use _PREFIX_/modules/all
299276
Then, load the EasyBuild module to update your environment and make EasyBuild available for use:
300277
301278
``` shell
302-
module load EasyBuild
279+
$ module load EasyBuild
280+
$ module list
281+
282+
Currently Loaded Modules:
283+
1) EasyBuild/5.0.0
284+
285+
$ eb --version
286+
This is EasyBuild 5.0.0 (framework: 5.0.0, easyblocks: 5.0.0) on host example.local
303287
```
304288
305289
!!! note
@@ -340,16 +324,14 @@ Hence, a modules tool must be available to consume module files with.
340324

341325
Supported module tools:
342326

343-
* [Tcl/C environment-modules](https://modules.sourceforge.net/) (version >= 3.2.10)
344-
* [Tcl-only variant of environment modules](https://sourceforge.net/projects/modules/files/Modules-Tcl)
345-
* [Lmod](https://lmod.sourceforge.net) (version >= 6.5.1), *highly recommended*
327+
* [Tcl/C environment-modules](https://modules.sourceforge.net/) (version >= 4.3.0)
328+
* [Lmod](https://lmod.sourceforge.net) (version >= 8.0.0)
346329

347330
!!! note
348331
The path to the actual modules tool binary/script used *must* be included in `$PATH`,
349332
to make it readily available to EasyBuild.
350333

351334
* for Tcl/C environment modules: `modulecmd`
352-
* for Tcl-only environment modules: `modulecmd.tcl`
353335
* for Lmod: `lmod`
354336

355337
The path where the modules tool binary/script is located can be determined via the definition of
@@ -359,9 +341,6 @@ Supported module tools:
359341
For Lmod, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
360342
environment variable, in case `lmod` is not available in `$PATH`.
361343

362-
In EasyBuild versions *prior* to 2.1.1, the path specified by `$LMOD_CMD` was (erroneously) preferred over the
363-
(first) `lmod` binary available via `$PATH`.
364-
365344
For modern Tcl-only environment modules (version >= 4.0.0), EasyBuild will try to fall back to finding the
366345
`modulecmd.tcl` binary via the `$MODULES_CMD` environment variable, in case `modulecmd.tcl` is not available
367346
in `$PATH`.
@@ -382,7 +361,7 @@ Additional notes:
382361

383362
### Required Python packages {: #required_python_packages }
384363

385-
Since EasyBuild v4.0, *no* Python packages outside of the Python standard library are required.
364+
EasyBuild requires *no* Python packages outside of the Python standard library.
386365

387366
## Optional dependencies
388367

@@ -391,8 +370,6 @@ Some dependencies are optional and are only required to support certain features
391370

392371
### Optional Python packages {: #optional_python_packages }
393372

394-
* [GC3Pie](https://pypi.org/project/gc3pie), only needed when using `GC3Pie` as a backend for `--job`,
395-
see also [Submitting jobs using --job][submitting_jobs];
396373
* [GitPython](https://github.com/gitpython-developers/GitPython), only needed if
397374
EasyBuild is hosted in a git repository or if you’re using a git
398375
repository for easyconfig files (.eb);
@@ -412,13 +389,13 @@ Some dependencies are optional and are only required to support certain features
412389
EasyBuild is split up into three different packages, which are available
413390
from the Python Package Index (PyPi):
414391

415-
* [easybuild-framework](http://pypi.python.org/pypi/easybuild-framework) - the EasyBuild framework, which includes the
392+
* [easybuild-framework](https://pypi.python.org/pypi/easybuild-framework) - the EasyBuild framework, which includes the
416393
easybuild.framework and easybuild.tools Python packages that provide
417394
general support for building and installing software
418-
* [easybuild-easyblocks](http://pypi.python.org/pypi/easybuild-easyblocks) - a collection of easyblocks that implement
395+
* [easybuild-easyblocks](https://pypi.python.org/pypi/easybuild-easyblocks) - a collection of easyblocks that implement
419396
support for building and installing (collections of) software
420397
packages
421-
* [easybuild-easyconfigs](http://pypi.python.org/pypi/easybuild-easyconfigs) - a collection of example easyconfig files
398+
* [easybuild-easyconfigs](https://pypi.python.org/pypi/easybuild-easyconfigs) - a collection of example easyconfig files
422399
that specify which software to build, and using which build options;
423400
these easyconfigs will be well tested with the latest compatible
424401
versions of the easybuild-framework and easybuild-easyblocks packages

0 commit comments

Comments
 (0)