Skip to content

Commit 8f35a8c

Browse files
committed
Corrected a number of spelling mistakes.
1 parent ae27a05 commit 8f35a8c

10 files changed

Lines changed: 30 additions & 30 deletions

docs/2022-CSC_and_LO/1_Intro/1_02_Lmod.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Unloading the environment module will restore the shell environment to its previ
2323
Environment module files are processed via a **modules tool**, of which there
2424
are several conceptually similar yet slightly different implementations.
2525
The oldest module tool still in use today is Environment Modules 3.2, implemented in C and
26-
supporting module files written in Tcl. After a gap in developement, Xavier Delaruelle of CEA
26+
supporting module files written in Tcl. After a gap in development, Xavier Delaruelle of CEA
2727
developed [Environment Modules 4 and 5](https://sourceforge.net/projects/modules/) which is
2828
fully implemented on Tcl. An alternative module tool is [Lmod](https://lmod.readthedocs.io),
2929
developed by Robert McLay at TACC and implemented in LUA. This tool supports natively LUA
@@ -39,7 +39,7 @@ Lmod also has some powerful features that are lacking in Environment Modules 3.2
3939
On LUMI, Lmod was selected as the module tool. One area where there are significant
4040
differences between Environment Modules 3.2 (and also the newer versions) and Lmod is
4141
in the commands for discovering modules on the system. If you are not familiar with Lmod
42-
and its commands for users, it is worthwile to read the
42+
and its commands for users, it is worthwhile to read the
4343
[LUMI documentation page on Lmod](https://docs.lumi-supercomputer.eu/computing/Lmod_modules/).
4444
Some of those commands are also discussed on this page.
4545

@@ -244,7 +244,7 @@ family('MPI')
244244
prepend_path('MODULEPATH', 'moduleroot/MPI/Compiler_A/version_A/MPI_C/version_C')
245245
```
246246

247-
Finally two vesions of the ``version_E.lua`` file are needed, one to prepare the environment for using the
247+
Finally two versions of the ``version_E.lua`` file are needed, one to prepare the environment for using the
248248
package with Compiler_A anmd MPI_C and one for using the package with Compiler_B and MPI_C. However, these
249249
are just regular modules and no additions are needed to work for the hierarchy.
250250

@@ -375,7 +375,7 @@ e.g., NumPy and SciPy for Python. Installing all those packages as separate modu
375375
to make it easy to see if they are installed or not on a system would lead to an
376376
overload of modules on the system.
377377

378-
Similary, admins of a software stack may chose to bundle several libraries or tools
378+
Similarly, admins of a software stack may chose to bundle several libraries or tools
379379
that are often used together in a single module (and single installation directory),
380380
e.g., to reduce module clutter but also to reduce the length of the search paths for
381381
binaries, libraries or manual pages to speed up loading of applications.
@@ -550,7 +550,7 @@ indicated version.
550550
Lmod works by executing the module file. However, the actions of all Lmod-defined
551551
functions will depend upon the mode in which Lmod is executing the module function,
552552
and the module file can also detect in which mode it is executing.
553-
Modes include "load", "unload"but also "spider". E.g., when te mode is "load", the
553+
Modes include "load", "unload" but also "spider". E.g., when the mode is "load", the
554554
``setenv`` function will set an environment variable to the indicated value while in
555555
"unload" mode that environment variable will be unset, and in "spider" mode the
556556
environment variable is left untouched. The working of ``prepend_path``, a function
@@ -564,7 +564,7 @@ in that PATH-style variable). When the mode is "spider", the function has specia
564564
if it is used to change the ``MODULEPATH``. It will then note the change and add that
565565
directory to the list of directories that has to be searched for module files.
566566
This makes ``module spider`` a very expensive command as it may have to traverse a lot
567-
of directories and has to execute all module files in there. Therefor Lmod will build
567+
of directories and has to execute all module files in there. Therefore Lmod will build
568568
a so-called spider cache which can be pre-built in the system for certain directories
569569
and otherwise will be build in the user's home directory (in the ``.lmod.d/.cache``
570570
subdirectory). Our experience is that this cache tends to be rather fragile,
@@ -661,7 +661,7 @@ module load MyPythonPackage/1.0
661661
Because of the *"one name rule"* this will again trigger an unload followed by a load
662662
of the module. The problem is in the unload. One would expect that first unloading
663663
``MyPythonPackage`` would remove the 2.7 directory from the ``PYTHON_PATH`` but it
664-
will not. Lmod does not remeber that last time it loaded ``MyPythonPackage`` it added
664+
will not. Lmod does not remember that last time it loaded ``MyPythonPackage`` it added
665665
the 2.7 directory to ``PythonPath``. Instead it will execute the commands in the
666666
modulefile and reverse certain commands. Since ``PYTHON_API_VERSION`` has now the value
667667
``3.6``, it will try to remove the directory for version ``3.6`` which is not in the

docs/2022-CSC_and_LO/1_Intro/1_03_CPE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
On LUMI, the main programming environment is the HPE Cray Programming Environment (further abbreviated
88
as Cray PE). The environment provides several tools, including compilers, communication libraries,
9-
optmized math libraries and various other libraries, analyzers and debuggers.
9+
optimised math libraries and various other libraries, analyzers and debuggers.
1010

11-
The Cray PE is made available through *environment modules* tha allow to select particular versions of
11+
The Cray PE is made available through *environment modules* that allow to select particular versions of
1212
tools and to configure the environment in a flexible way.
1313

1414
---
@@ -145,7 +145,7 @@ These libraries satisfy dependencies for many commonly used applications on Cray
145145
When the module for a CSML package (such as `cray-libsci` or `cray-fftw`) is loaded,
146146
all relevant headers and libraries for these packages are added to the compile
147147
and link lines of the `cc`, `ftn`, and `CC` compiler wrappers, so linking with them is
148-
completely transparant (to the extent that users wonder where the libraries are).
148+
completely transparent (to the extent that users wonder where the libraries are).
149149

150150
The CSML collection contains the following Scientific Libraries:
151151

@@ -326,7 +326,7 @@ can be set through target modules:
326326
``craype-network-ucx`` module.
327327

328328
- The ``craype-hugepages*`` modules enable Cray Huge Pages support. To fully enable this support they have to
329-
be used at link-time and at run-time. At link time, support is compiled into the binary wile at run-time they
329+
be used at link-time and at run-time. At link time, support is compiled into the binary while at run-time they
330330
are used to set the actual size of the huge pages.
331331

332332
The ``craype-hugepages*`` modules are not supported by all compilers. E.g., the AOCC compiler does not support
@@ -375,7 +375,7 @@ is loaded first.
375375

376376
## Some unexpected behaviour of the Cray PE
377377

378-
On Cray EX systems, dynamic linking is the preferred way of linking applications. Whith that comes some
378+
On Cray EX systems, dynamic linking is the preferred way of linking applications. With that comes some
379379
unexpected behaviour of the Cray modules. EasyBuild users expect that at run time the versions of the
380380
libraries that are used, are the ones from the modules that are loaded. This is not always the case
381381
for the runtime libraries of the Cray PE. By default the Cray PE will use a default set of libraries

docs/2022-CSC_and_LO/1_Intro/1_04_LUMI_software_stack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
---
66

77
The user-facing documentation on how to use the LUMI software stacks is
8-
avialable in [the LUMI documentation](https://docs.lumi-supercomputer.eu/computing/softwarestacks/).
8+
available in [the LUMI documentation](https://docs.lumi-supercomputer.eu/computing/softwarestacks/).
99
On this page we focus more on the technical implementation behind it.
1010

1111
---

docs/2022-CSC_and_LO/1_Intro/1_07_configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and to configure EasyBuild according to your preferences and the system on which
1414

1515
!!! Note "EasyBuild configuration on LUMI"
1616

17-
On LUMI serveral configurations of EasyBuild are already available.
17+
On LUMI several configurations of EasyBuild are already available.
1818

1919
The ``EasyBuild-user`` module is the most important one. It will configure EasyBuild
2020
to install software in either a default location in the user's home directory
@@ -104,7 +104,7 @@ and the default `software` and `modules/all` names for the subdirectories are us
104104

105105
This makes it slightly easier to organise the module tree with user-friendly labeling, but above
106106
all also makes the synchronisation process of the 4 instances of the software directory more robust
107-
as it is now easy to synchonise all modules in the last step, which is a much quicker process than
107+
as it is now easy to synchronise all modules in the last step, which is a much quicker process than
108108
syncrhonising the software installations.
109109

110110
We also use short paths for software installations (to avoid overrunning the maximum length of a

docs/2022-CSC_and_LO/1_Intro/1_08_basic_usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ Dry run: printing build status of easyconfigs and dependencies
524524
== Temporary directory /run/user/10012026/easybuild/tmp/eb-wm_bk3j6 has been removed.
525525
```
526526
527-
and now instal the library:
527+
and now install the library:
528528
529529
```shell
530530
$ eb libdap-3.20.9-cpeGNU-21.12.eb
@@ -782,7 +782,7 @@ sourcepath (E) = /users/XXXXXXXX/LUMI-user/sources:/appl/lumi/sources
782782
...
783783
```
784784
785-
This is sligthly different from the default EasyBuild setup, where the modules, software,
785+
This is slightly different from the default EasyBuild setup, where the modules, software,
786786
repository and sources would be installed in respectively the subdirectories `modules`,
787787
`software`, `ebfiles_repo` and `sources` of the directory pointed to by the `installpath`
788788
line.
@@ -932,7 +932,7 @@ Currently Loaded Modules:
932932
S: Module is Sticky, requires --force to unload or purge
933933
```
934934
935-
Runnin `module --force purge` instead will remove all modules, including the `init-lumi`
935+
Running `module --force purge` instead will remove all modules, including the `init-lumi`
936936
module which does part of the initialisation. You will not be able to use the software
937937
stacks completely as before without first loading `init-lumi` in its most recent (or default)
938938
version again!

docs/2022-CSC_and_LO/2_Using/2_02_creating_easyconfig_files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ specific parameter is less useful on LUMI as we currently try to build on top of
318318
319319
The `buildtools` build dependency shows that there is a fourth parameter specifying the toolchain
320320
used for that dependency and is needed if that toolchain is different from the one used in the example.
321-
As it is not possible to load several Cray toolchains together (they are not in a hierachical relation)
321+
As it is not possible to load several Cray toolchains together (they are not in a hierarchical relation)
322322
the only useful value on LUMI is `True` which tells that `buildtools` is build with the `SYSTEM`
323323
toolchain. Here also we use a template, `%(toolchain_version)s` which - as its name suggests - expands
324324
to the version of the toolchain, as we version our `buildtools` modules after the version of the Cray
@@ -569,7 +569,7 @@ homepage = 'https://easybuilders.github.io/easybuild-tutorial'
569569
whatis = [ 'Description: EasyBuild tutorial example']
570570
571571
description = """
572-
This is a short C++ example program that can be buid using CMake.
572+
This is a short C++ example program that can be build using CMake.
573573
"""
574574
```
575575
@@ -582,7 +582,7 @@ ERROR: Failed to process easyconfig /pfs/lustrep4/users/XXXXXXXX/easybuild-tutor
582582
No software-specific easyblock 'EB_eb_minus_tutorial' found for eb-tutorial
583583
```
584584
585-
It is not mandatory to specify an easyblock in the easyconfig. However, in the absense of that
585+
It is not mandatory to specify an easyblock in the easyconfig. However, in the absence of that
586586
specification, EasyBuild goes looking for an application-specific easyblock with the standard name,
587587
in this case `EB_eb_minus_tutorial`, which it does not have. Does that mean we have to implement an easyblock?
588588

docs/2022-CSC_and_LO/2_Using/2_04_implementing_easyblocks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ module location for a particular software name or easyblock class name. For exam
107107
```
108108

109109
The location of the Python module is determined by whether the easyblock is generic or software-specific.
110-
Generic easyblocks are located in the ``easybuid.easyblocks.generic`` namespace, while software-specific easyblocks
110+
Generic easyblocks are located in the ``easybuild.easyblocks.generic`` namespace, while software-specific easyblocks
111111
live in the ``easybuild.easyblocks`` namespace directly.
112112

113113
To keep things organised, the actual Python module files
@@ -661,7 +661,7 @@ Your easyblock should:
661661
whatis = [ 'Description: EasyBuild tutorial example']
662662

663663
description = """
664-
This is a short C++ example program that can be buid using CMake.
664+
This is a short C++ example program that can be build using CMake.
665665
"""
666666

667667
toolchain = {'name': 'cpeCray', 'version': '21.12'}

docs/2022-CSC_and_LO/3_Advanced/3_03_slurm_jobs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ It is important to be aware of some details before you start using this, which w
2121
temporary files and build directory. Those have to be made by hand.
2222

2323
Due to the setup of the central software stack, this feature is currently useless to install
24-
the central stack. For user installations, there are also limitations as the enviornment
24+
the central stack. For user installations, there are also limitations as the environment
2525
on the compute nodes is different from the login nodes so, e.g., different locations for
2626
temporary files are being used. These would only be refreshed if the EasyBuild configuration
2727
modules are reloaded on the compute nodes which cannot be done currently in the way Slurm
@@ -178,7 +178,7 @@ To remedy this, there are a couple of EasyBuild configuration options you can us
178178
The build directory of course also suffers from the problem of being no longer accessible if the
179179
installation fails, but there it is not so easy to find a solution. Building on a shared file system
180180
is not only much slower, but in particular on parallel file systems like GPFS/SpectrumScale, Lustre
181-
or BeeGFS buiding sometimes fails in strange ways. One thing you can consider if you cannot do the
181+
or BeeGFS building sometimes fails in strange ways. One thing you can consider if you cannot do the
182182
build on a login node (e.g., because the code is not suitable for cross-compiling or the configure
183183
system does tests that would fail on the login node), is to rety the installation in an
184184
interactive job, so you can inspect the build directory after the installation fails.

docs/2022-CSC_and_LO/3_Advanced/3_04_module_naming_schemes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module naming schemes, which are characterized by:
4949

5050
In contrast, a *hierarchical* module naming scheme
5151
consists of a *hierarchy* of module files.
52-
A fairly typical 3-level schme (``Core``, ``Compiler`` and ``MPI``) has been
52+
A fairly typical 3-level scheme (``Core``, ``Compiler`` and ``MPI``) has been
5353
discussed in the [section on Lmod](../1_Intro/1_02_Lmod#lmod-hierarchy).
5454
This typical Lmod hierarcny would map very well on the EasyBuild common toolchains.
5555

@@ -67,7 +67,7 @@ would be installed using the regular ``foss`` toolchain or the ``gompi`` toolcha
6767
On LUMI, where software is installed through the Cray Programming Environment with no real choice of
6868
MPI implementation, a two-level arrangement would still make a lot of sense, with at the ``Core`` level
6969
all software compiled with the SYSTEM toolchain while there could be a ``PrgEnv`` level for software
70-
compiled with a particula programming enviornment aka cepGNU/cpeCray/cpeAOCC toolchain. Such a scheme
70+
compiled with a particula programming environment aka cepGNU/cpeCray/cpeAOCC toolchain. Such a scheme
7171
is used on the Cray systems at CSCS.
7272

7373
To recap, the characteristics of a module hierarchy are:
@@ -164,7 +164,7 @@ loaded on LUMI this was not possible to accomplish without losing other function
164164

165165
Next to the module naming schemes that are included with EasyBuild,
166166
you can also define your own module naming scheme (MNS), and configure EasyBuild to use it
167-
(which is eactly what has been done on LUMI to remove a feature of the default ``EasyBuildMNS`` scheme
167+
(which is exactly what has been done on LUMI to remove a feature of the default ``EasyBuildMNS`` scheme
168168
that we do not use).
169169

170170
### Implementation
@@ -288,7 +288,7 @@ $ eb SciPy-bundle-2020.11-foss-2020b-Python-2.7.18.eb -D
288288

289289
!!! Warning "Example not suitable for LUMI"
290290
**This exercise is meant for a system where the common toolchains can be used and requires an
291-
indpendent EasyBuild installation in your personal file space**,
291+
independent EasyBuild installation in your personal file space**,
292292
because EasyBuild will try to copy the installation log file to each installation directory.
293293

294294
Now that we know more about hierarchical module naming schemes,

docs/2022-CSC_and_LO/4_00_additional_reading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
EasyBuild.
1212
- [EasyBuild YouTube channel](https://www.youtube.com/c/EasyBuilders)
1313
- This tutorial is an evolution of the
14-
[EasyBuild tutorial prepared for the LUMI User Suppport Team, spring '21](https://easybuilders.github.io/easybuild-tutorial/2021-lust/)
14+
[EasyBuild tutorial prepared for the LUMI User Support Team, spring '21](https://easybuilders.github.io/easybuild-tutorial/2021-lust/)
1515
given by Kenneth Hoste (UGent, EasyBuild lead developer) and Luca Marsella (CSCS)
1616
- [Recordings are available on YouTube](https://www.youtube.com/watch?v=JTRw8hqi6x0&list=PLhnGtSmEGEQh573bk3BeOj_KCRBBiA5OT)
1717
- The EasyBuild setup on LUMI is partly insprired on the setup used at CSCS on their Cray systems

0 commit comments

Comments
 (0)