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
Fix: Correct Spack capitalization in tutorial files.
This commit corrects the capitalization of "Spack" in all tutorial_*.rst files.
The changes ensure that:
- "Spack" is used when referring to the project or tool by name.
- "spack" is used when referring to the command-line executable.
Dependencies can set environment variables that are required when their dependents build.
77
-
For example, when a package depends on a python extension like py-numpy, Spack's ``python`` package will add it to ``PYTHONPATH`` so it is available at build time; this is required because the default setup that spack does is not sufficient for python to import modules.
77
+
For example, when a package depends on a python extension like py-numpy, Spack's ``python`` package will add it to ``PYTHONPATH`` so it is available at build time; this is required because the default setup that Spack does is not sufficient for python to import modules.
78
78
79
79
To provide environment setup for a dependent, a package can implement the
Copy file name to clipboardExpand all lines: tutorial_configuration.rst
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,19 +35,19 @@ A partial list of some key configuration sections is provided below.
35
35
- Naming, location and additional configuration of Spack generated modules
36
36
37
37
The full list of sections can be viewed with ``spack config list``.
38
-
For further education, we encourage you to explore the spack `documentation on configuration files <https://spack.readthedocs.io/en/latest/configuration.html#configuration-files>`_.
38
+
For further education, we encourage you to explore the Spack `documentation on configuration files <https://spack.readthedocs.io/en/latest/configuration.html#configuration-files>`_.
39
39
40
40
The principle goals of this section of the tutorial are:
41
41
42
42
1. Introduce the configuration sections and scope hierarchy
43
43
2. Demonstrate how to manipulate configurations
44
-
3. Show how to configure system assets with spack (compilers and packages)
44
+
3. Show how to configure system assets with Spack (compilers and packages)
45
45
46
46
As such, we will primarily focus on the ``compilers`` and ``packages`` configuration sections in this portion of the tutorial.
47
47
48
48
We will explain this by first covering how to manipulate configurations from the command line and then show how this impacts the configuration file hierarchy.
49
49
We will then move into compiler and package configurations to help you develop skills for getting the builds you want on your system.
50
-
Finally, we will give some brief attention to more generalized spack configurations in the ``config`` section.
50
+
Finally, we will give some brief attention to more generalized Spack configurations in the ``config`` section.
51
51
52
52
For all of these features, we will demonstrate how we build up a full configuration file.
53
53
For some, we will then demonstrate how the configuration affects the install command, and for others we will use the ``spack spec`` command to demonstrate how the configuration changes have affected Spack's concretization algorithm.
@@ -81,7 +81,7 @@ If we rerun ``spack config blame concretizer`` we can see that the change was ap
81
81
$ spack config blame concretizer
82
82
83
83
Notice that the reference file for this option is now different.
84
-
This indicates the scope where the configuration was set in, and we will discuss how spack chooses the default scope shortly.
84
+
This indicates the scope where the configuration was set in, and we will discuss how Spack chooses the default scope shortly.
85
85
For now, it is important to note that the ``spack config`` command accepts an optional ``--scope`` flag so we can be more precise in the configuration process.
86
86
This will make more sense after the next section which provides the definition of Spack's configuration scopes and their hierarchy.
87
87
@@ -485,7 +485,7 @@ Because of the configuration scoping we discussed earlier, this overrides the de
485
485
Variant preferences
486
486
^^^^^^^^^^^^^^^^^^^
487
487
488
-
As we've seen throughout this tutorial, HDF5 builds with MPI enabled by default in Spack.
488
+
As we'veseen throughout this tutorial, HDF5 builds with MPI enabled by default in Spack.
489
489
If we were working on a project that would routinely need serial HDF5, that might get annoying quickly, having to type ``hdf5~mpi`` all the time.
490
490
Instead, we'll update our preferences for HDF5.
491
491
@@ -813,3 +813,5 @@ For more detailed documentation on Spack's many configuration settings, see `the
813
813
814
814
For examples of how other sites configure Spack, see https://github.com/spack/spack-configs.
815
815
If you use Spack at your site and want to share your config files, feel free to submit a pull request!
Copy file name to clipboardExpand all lines: tutorial_developer_workflows.rst
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
Developer Workflows Tutorial
12
12
============================
13
13
14
-
This tutorial will guide you through the process of using the ``spack develop`` command to develop software from local source code within a spack environment.
14
+
This tutorial will guide you through the process of using the ``spack develop`` command to develop software from local source code within a Spack environment.
15
15
With this command, Spack will manage your dependencies while you focus on testing changes to your library and/or application.
16
16
17
17
@@ -139,19 +139,19 @@ Development iteration cycles
139
139
-----------------------------
140
140
141
141
Let's assume that scr has a bug, and we'd like to patch scr to find out what the problem is.
142
-
First, we tell spack that we'd like to check out the version of scr that we want to work on.
142
+
First, we tell Spack that we'd like to check out the version of scr that we want to work on.
143
143
In this case, it will be the 3.1.0 release that we want to write a patch for:
144
144
145
145
.. literalinclude:: outputs/dev/develop-1.out
146
146
:language: console
147
147
148
-
The spack develop command marks the package as being a "development" package in the ``spack.yaml``.
148
+
The ``spack develop`` command marks the package as being a "development" package in the ``spack.yaml``.
149
149
This adds a special ``dev_path=`` attribute to the spec for the package, so Spack remembers where the source code for this package is located.
150
150
The develop command also downloads/checks out the source code for the package.
151
151
By default, the source code is downloaded into a subdirectory of the environment.
152
152
You can change the location of this source directory by modifying the ``path:`` attribute of the develop configuration in the environment.
153
153
154
-
There are a few gotchas with the spack develop command
154
+
There are a few gotchas with the ``spack develop`` command
155
155
156
156
* You often specify the package version manually when specifying a
157
157
package as a dev package. Spack needs to know the version of the dev
@@ -233,7 +233,7 @@ For example, we'll make another development environment here.
233
233
234
234
Here, ``spack develop`` with no arguments will check out or download the source code and place it in the appropriate places.
235
235
236
-
When we're done developing, we simply tell spack that it no longer needs to keep a development version of the package.
236
+
When we're done developing, we simply tell Spack that it no longer needs to keep a development version of the package.
237
237
238
238
.. literalinclude:: outputs/dev/wrapup.out
239
239
:language: console
@@ -328,3 +328,5 @@ While we won't build out this example it illustrates how the ``dev_path`` for ``
328
328
Now if we want to do most of our incremental builds using the ``Release`` build and periodically check the results using the ``Debug`` build we can combine the workflow from the previous example: dive into the ``Release`` versions build environment using ``spack build-env scr build_type=Release -- bash`` and navigate with ``spack cd -b scr build_type=Release``.
329
329
Note that since there are two ``scr`` specs in the environment we must distinguish which one we want for these commands.
330
330
When we are ready to check our changes for the debug build, we can exit out of the build environment subshell, rerun ``spack install`` to rebuild everything, and then inspect the debug build through our method of choice.
0 commit comments