Skip to content

Commit 796e201

Browse files
committed
A few additional subjective improvements to readability
Signed-off-by: Alec Scott <alec@llnl.gov>
1 parent 06c80b6 commit 796e201

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

tutorial_environments.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ So far in this tutorial, we've covered the basic commands for managing individua
1919
.. Customizing Spack's installation with configuration files, like
2020
`packages.yaml <https://spack.readthedocs.io/en/latest/build_settings.html#build-settings>`_, was also discussed.
2121
22-
Now we'll explore Spack Environments, a powerful feature that lets us manage collections of packages together in a documented and reproducible way.
23-
Spack environments are similar to *virtual environments* in other package managers (e.g., `Python venv <https://docs.python.org/3/library/venv.html>`_, `Conda Environments <https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html>`_, or `nix-env <https://nix.dev/manual/nix/2.24/command-ref/nix-env>`_).
22+
Now we'll explore Spack environments, a powerful feature that lets us manage collections of packages together in a documented and reproducible way.
23+
Spack environments are similar to *virtual environments* in other package managers (e.g., `Python venv <https://docs.python.org/3/library/venv.html>`_, `Conda environments <https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html>`_, or `nix-env <https://nix.dev/manual/nix/2.24/command-ref/nix-env>`_).
2424

2525
Managing a software stack with many packages and varying configuration can quickly become hard to track by hand.
2626
An environment lets you:

tutorial_packaging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Let's make the following changes:
182182

183183
Now make the changes and additions to your ``package.py`` file.
184184

185-
The resulting package should contain -- sans the copyright and license -- the following information:
185+
The resulting package should contain the following information, omitting the copyright and license:
186186

187187
.. literalinclude:: tutorial/examples/packaging/1.package.py
188188
:caption: tutorial-mpileaks/package.py (from tutorial/examples/packaging/1.package.py)

tutorial_stacks.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Our goal is to install ``netlib-scalapack`` compiled with ``gcc@16``, which is n
2020

2121
- two MPI libraries (``openmpi`` and ``mpich``)
2222
- two LAPACK providers (``openblas`` and ``netlib-lapack``)
23+
2324
We'll also install ``py-scipy`` linked against ``openblas``.
2425

2526
We'll first focus on how to configure and install the software correctly.
@@ -79,7 +80,7 @@ Spec groups offer a better tool: the ``override`` block, which scopes any Spack
7980
:language: yaml
8081
:emphasize-lines: 11-18,23-30
8182

82-
Here we used it to set compiler preferences at the language level, once for each group:
83+
Here we used the ``override`` block to set compiler preferences at the language level, once for each group:
8384

8485
1. The ``compiler`` group prefers ``gcc@15``
8586
2. The ``stack`` group prefers ``gcc@16``
@@ -282,7 +283,7 @@ Alternatively, to create a buildcache you can:
282283
$ spack gpg create <name> <e-mail>
283284
$ spack buildcache push ./mirror
284285
285-
Don't forget to set an appropriate value for the padding of the install tree, see `how to setup relocation <https://spack.readthedocs.io/en/latest/binary_caches.html#relocation>`_ in our documentation.
286+
Don't forget to set an appropriate value for the padding of the install tree; see `how to set up relocation <https://spack.readthedocs.io/en/latest/binary_caches.html#relocation>`_ in our documentation.
286287

287288
--------------------------
288289
Multiple Filesystem Views
@@ -372,7 +373,7 @@ Let's check the generated module files:
372373
:language: console
373374

374375
The set of modules is already usable, and the hierarchy already works.
375-
For instance, we can load the ``gcc`` compiler and check that we have ``gcc`` in our path and a lot of modules available, all compiled with ``gcc@16``:
376+
For instance, we can load the ``gcc`` compiler and check that ``gcc`` is in our path and that many modules are available, all compiled with ``gcc@16``:
376377

377378
.. literalinclude:: outputs/stacks/modules-3.out
378379
:language: console

0 commit comments

Comments
 (0)