Skip to content

Commit 9284ca2

Browse files
authored
Merge pull request #10 from laraPPr/small_fixes
Grammar fixes
2 parents ff35abf + 49325ea commit 9284ca2

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/installing-on-top.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ Some characteristics of the project are
111111
- This introduces another dependency on `CMake` itself which we only require during the building of the project.
112112
Such dependencies are often called _build-time dependencies_.
113113
- Testing
114-
- `CMake` has some features that allow for the running of tests that are included in our software project. This
115-
gives us an easy way to check both that our software runs, and that it gives correct results, without us needing
116-
to run and verify each check manually.
114+
- `CMake` has some features that allow for the running of tests that are included in our software project. This
115+
gives us an easy way to check both that our software runs, and that it gives correct results, without us needing
116+
to run and verify each check manually.
117117

118118
### Loading our dependencies
119119

120-
We first need to provide our dependencies before we can build our project. We first need to ensure that EESSI is
120+
We first need to provide our dependencies before we can build our project. But before we can do that, we need to ensure that EESSI is
121121
initialised:
122122
``` { .bash .copy}
123123
source /cvmfs/software.eessi.io/versions/2025.06/init/lmod/bash
@@ -157,12 +157,12 @@ first part of `1.14.6-gompi-2025b`, in this case `1.14.6`; the final part `gompi
157157
[toolchain concept used by EasyBuild](https://docs.easybuild.io/common-toolchains/). We won't dive into that toolchain
158158
concept here since it is not the purpose of the tutorial.
159159

160-
Having chose to try out `HDF5/1.14.6-gompi-2025b`, we can now load the module to make HDF5 available:
160+
Since we chose to try out `HDF5/1.14.6-gompi-2025b`, we can now load the module to make HDF5 available:
161161
``` { .bash .copy}
162162
module load HDF5/1.14.6-gompi-2025b
163163
```
164164

165-
After wards we can check what our environment currently looks like with
165+
Once HDF5 is loaded, we can check what our environment currently looks like with:
166166
``` { .bash .no-copy}
167167
$ module list
168168

@@ -177,7 +177,7 @@ Currently Loaded Modules:
177177
8) OpenSSL/3 18) Perl/5.40.2-GCCcore-14.3.0
178178
9) libevent/2.1.12-GCCcore-14.3.0 19) HDF5/1.14.6-gompi-2025b
179179
```
180-
That's now a long of packages which make up the _runtime dependency tree_ of `HDF5`. That dependency tree includes
180+
That will show a long list of packages which make up the _runtime dependency tree_ of `HDF5`. That dependency tree includes
181181
`OpenMPI/5.0.8-GCC-14.3.0` which means the list already satisfies the runtime requirements for our software package.
182182

183183
However, we are still missing our _build-time dependency_ `CMake`. Can EESSI also provide that? Let's check with
@@ -222,7 +222,7 @@ We don't have any reason to choose one over the other, so let's go with the most
222222
module load CMake/4.0.3-GCCcore-14.3.0
223223
```
224224

225-
With this module loaded, we now have all both our build-time and runtime dependencies satisfied, and can proceed to
225+
With this module loaded, we now have both our build-time and runtime dependencies satisfied, and can proceed to
226226
build our project.
227227

228228
### First attempt at building and testing our project
@@ -663,7 +663,7 @@ the first place. Such issues are the reason that tools such as [EasyBuild](https
663663

664664
In EESSI, EasyBuild is used exclusively to deliver packages in the software layer. EasyBuild has hundreds
665665
of configuration options though, and the shared environment of EESSI means that we need everyone to be using a
666-
consistent configuration of EasyBuild so that we all start from same base. There are multiple ways that one can
666+
consistent configuration of EasyBuild so that we all start from same the base. There are multiple ways to
667667
[configure EasyBuild](https://docs.easybuild.io/configuration/), one of which is by using _environment variables_.
668668
Since environment modules are an exact match for this case, it is convenient (and consistent with our general approach)
669669
to use an environment module to configure EasyBuild for use with EESSI. For the current version of EESSI that we have
@@ -690,7 +690,7 @@ recipe (or _easyconfig_) for EasyBuild targeting the package we have been workin
690690

691691
!!! warning
692692

693-
The easyconfig targets the package that is under the EESSI organisation, not the one you are using locally.
693+
The easyconfig targets the package that is under the EESSI organisation, not the one you are using locally (which is under your GitHub account).
694694

695695
```bash title="cicd-demo-0.1.0-gompi-2025b.eb"
696696
--8<-- "scripts/cicd-demo-0.1.0-gompi-2025b.eb"
@@ -812,7 +812,7 @@ Rank 1 wrote value 1 to file 'parallel_hello.h5'
812812
### Going further with `EESSI-extend`
813813

814814
We have seen that we use `EESSI-extend` to install an EasyBuild recipe, replicating the approach taken by EESSI itself
815-
when installing packages. EasyBuild has over support for almost 3000 software packages, and thousands of extensions for
815+
when installing packages. EasyBuild has support for almost 3000 software packages, and thousands of extensions for
816816
things like `R` and `Python`. If you want to explore whether EasyBuild already has support for a package you are
817817
interested in you can use, for example,
818818
``` { .bash .copy }

docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ EESSI should work on laptops, personal workstations, HPC clusters and in the clo
2222
We hope to make this work for any Linux distribution, and maybe even macOS and Windows via [WSL](https://docs.microsoft.com/en-us/windows/wsl/),
2323
and a wide variety of CPU architectures (Intel, AMD, ARM, POWER, RISC-V).
2424

25-
We focus not only the **performance** of the provided software installations, but also on automating the workflow
25+
We focus not only on the **performance** of the provided software installations, but also on automating the workflow
2626
for maintaining the software stack, thoroughly testing the installations, and collaborating efficiently.
2727

2828
## Inspiration
@@ -113,7 +113,7 @@ The software layer is maintained through our [https://github.com/EESSI/software-
113113

114114
## Current status
115115

116-
The EESSI project was started mid 2020, as a loose collaboration between various Dutch universities including
116+
The EESSI project was started mid 2020, as a loose collaboration between various universities including
117117
the [University of Groningen](https://www.rug.nl/society-business/centre-for-information-technology), [VU
118118
Amsterdam](https://vu.nl/en), [TU Delft](https://www.tudelft.nl/en/), [TU Eindhoven](https://www.tue.nl/en/), and
119119
[HPC-UGent](https://www.ugent.be/hpc/en), as a follow-up of a meeting organised in Delft in early March 2020

0 commit comments

Comments
 (0)