You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorial_environments.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,7 @@ Using Packages
181
181
Spack environments provide a convenient way to use your installed packages by automatically making them available in your shell environment.
182
182
This is accomplished through a feature called **environment views**.
183
183
184
-
An environment view is a directory structure mirroring a standard linux root filesystem with directories like ``/bin`` and ``/usr`` that contain symbolic links to all the packages installed in your Spack environment.
184
+
An environment view is a directory structure mirroring a standard Linux root filesystem with directories like ``/bin`` and ``/usr`` that contain symbolic links to all the packages installed in your Spack environment.
185
185
When you activate an environment with ``spack env activate``, Spack automatically:
186
186
187
187
* Prepends the view's ``bin`` directory to your ``PATH`` environment variable
Copy file name to clipboardExpand all lines: tutorial_modules.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Module Files Tutorial
13
13
This tutorial illustrates how Spack can be used to generate module files for the software that has been installed.
14
14
Both hierarchical and non-hierarchical deployments will be discussed in detail and we will show how to customize the content and naming of each module file.
15
15
16
-
At the end of the tutorial readers should have a clear understanding of:
16
+
At the end of the tutorial, readers will have a clear understanding of:
17
17
18
18
* What module files are and how they are used on HPC clusters
19
19
* How Spack generates module files for the software it installs
@@ -178,7 +178,7 @@ For further details we refer to its `documentation <https://modules.readthedocs.
178
178
""""
179
179
Lmod
180
180
""""
181
-
Lmod is a module system written in Lua, originally created at the "Texas Advanced Computing Center" (TACC) by Robert McLay.
181
+
Lmod is a module system written in Lua, originally created at the Texas Advanced Computing Center (TACC) by Robert McLay.
182
182
You can get it with:
183
183
184
184
.. code-block:: spec
@@ -210,7 +210,7 @@ Modules vs ``spack load``
210
210
^^^^^^^^^^^^^^^^^^^^^^^^^
211
211
212
212
You may have noticed that we used ``spack load`` in the :ref:`module_file_tutorial_prerequisites` section above.
213
-
This is a built-in mechanism of Spack's -- it's designed so that users on a cluster or a laptop can quickly get a package into their path, and it understands Spack's spec syntax.
213
+
This is a built-in mechanism of Spack -- it's designed so that users on a cluster or a laptop can quickly get a package into their path, and it understands Spack's spec syntax.
214
214
It does *not* require modules, as Spack needs to work regardless of whether modules are set up on the system.
215
215
216
216
As you might expect, you can see what is loaded via ``spack load`` using ``spack find``:
@@ -411,7 +411,7 @@ If you try to regenerate the module files now you will get an error:
411
411
.. note::
412
412
We try to check for errors up front!
413
413
414
-
In Spack we check for errors upfront whenever possible, so don't worry about your module files: as a name clash was detected nothing has been changed on disk.
414
+
In Spack we check for errors up front whenever possible, so don't worry about your module files: as a name clash was detected nothing has been changed on disk.
415
415
416
416
The problem here is that without the hashes the four different flavors of ``netlib-scalapack`` map to the same module file name.
417
417
We can change how the names are formatted to differentiate them:
@@ -859,7 +859,7 @@ Extend the default templates
859
859
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
860
860
861
861
Let's assume one of our software is protected by group membership: allowed users belong to the same Linux group, and access is granted at the group level.
862
-
Wouldn't it be nice if people that are not yet entitled to use it could receive a helpful message at module load time that tells them who to contact in your organization to be inserted in the group?
862
+
Wouldn't it be nice if people who are not yet entitled to use it could receive a helpful message at module load time that tells them who to contact in your organization to be inserted in the group?
863
863
864
864
To automate the generation of module files with such site-specific behavior we'll start by extending the list of locations where Spack looks for module files.
865
865
Let's create the file ``${SPACK_ROOT}/etc/spack/config.yaml`` with the content:
Copy file name to clipboardExpand all lines: tutorial_packaging.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -301,7 +301,7 @@ Our options for proceeding are:
301
301
Reviewing the Build Log
302
302
~~~~~~~~~~~~~~~~~~~~~~~
303
303
304
-
The build log might yield some clues so let's look at the contents of the ``spack-build-out.txt`` file at the path recommended above by our failed installation:
304
+
The build log might yield some clues, so let's look at the contents of the ``spack-build-out.txt`` file at the path recommended above by our failed installation:
@@ -617,7 +617,7 @@ Spack has thousands of built-in packages that can serve as examples to guide the
617
617
Multiple Build Systems
618
618
----------------------
619
619
620
-
There are cases where software actively supports two build systems; changes build systems as it evolves; or needs different build systems on different platforms.
620
+
There are cases where software actively supports two build systems, changes build systems as it evolves, or needs different build systems on different platforms.
621
621
Spack allows you to write a single, concise recipe for these cases that generally require minor changes to the package structure.
622
622
623
623
Let's take a look at a *simplified* package for ``uncrustify``, which is a source code beautifier.
Copy file name to clipboardExpand all lines: tutorial_stacks.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,7 @@ Reusable definitions
181
181
So far, we have seen how we can use spec matrices to generate cross-product specs from rows containing a list of constraints.
182
182
A common situation you will encounter with large deployments is the necessity to add multiple matrices to the list of specs, that possibly share some of those rows.
183
183
184
-
To reduce the amount of duplication needed in the manifest file, and thus the maintenance burden for people maintaining it, Spack allows to *define* lists of constraints under the ``definitions`` attribute, and expand them later when needed.
184
+
To reduce the amount of duplication needed in the manifest file, and thus the maintenance burden, Spack allows to *define* lists of constraints under the ``definitions`` attribute, and expand them later when needed.
0 commit comments