Skip to content

Commit b1e21fd

Browse files
committed
fmt
1 parent 4b79734 commit b1e21fd

2 files changed

Lines changed: 19 additions & 14 deletions

File tree

index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@
88
Tutorial: Spack 101
99
===================
1010

11-
This is an introduction to Spack with lectures and live demos.
12-
It was last presented at the `Supercomputing 2024 Conference <https://sc24.conference-program.com/presentation/?id=tut182&sess=sess422>`_, November 18, 2024.
13-
The event was a full-day tutorial.
11+
This is an introduction to Spack with lectures and live demos. It was last presented at
12+
the `Supercomputing 2024 Conference
13+
<https://sc24.conference-program.com/presentation/?id=tut182&sess=sess422>`_, November
14+
18, 2024. The event was a full-day tutorial.
1415

15-
You can use these materials to teach a course on Spack at your own site, or you can just skip ahead and read the live demo scripts to see how Spack is used in practice.
16+
You can use these materials to teach a course on Spack at your own site,
17+
or you can just skip ahead and read the live demo scripts to see how
18+
Spack is used in practice.
1619

1720
.. _slides:
1821

@@ -34,7 +37,8 @@ Supercomputing 2024 (SC24), Atlanta, GA, November 18, 2024.
3437

3538
.. rubric:: Video
3639

37-
For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version <https://spack-tutorial.readthedocs.io/en/hpcic24/>`_.
40+
For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version
41+
<https://spack-tutorial.readthedocs.io/en/hpcic24/>`_.
3842

3943
.. _live-demos:
4044

@@ -43,8 +47,8 @@ For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 versi
4347
We provide scripts that take you step-by-step through basic Spack tasks.
4448
They correspond to sections in the slides above.
4549

46-
To run through the scripts, we provide the `spack/tutorial <https://ghcr.io/spack/tutorial>`_ container image.
47-
You can invoke
50+
To run through the scripts, we provide the `spack/tutorial <https://ghcr.io/spack/tutorial>`_
51+
container image. You can invoke
4852

4953
.. code-block:: console
5054
@@ -62,7 +66,8 @@ to start using the container. You should now be ready to run through our demo sc
6266
#. :ref:`binary-cache-tutorial`
6367
#. :ref:`spack-scripting-tutorial`
6468

65-
Other sections from past tutorials are also available, although they may not be kept up-to-date as frequently:
69+
Other sections from past tutorials are also available, although they may
70+
not be kept up-to-date as frequently:
6671

6772
#. :ref:`modules-tutorial`
6873
#. :ref:`build-systems-tutorial`

tutorial_buildsystems.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Spack Package Build Systems
1111
===========================
1212

13-
After writing a few package template files, certain recurring patterns often become apparent.
13+
After writing a few package template files, certain recurring patterns often become apparent.
1414
For example, an ``install()`` method may frequently include the following steps:
1515

1616
- ``configure``
@@ -20,7 +20,7 @@ For example, an ``install()`` method may frequently include the following steps:
2020

2121
It's also common to pass arguments such as ``"prefix=" + prefix`` to ``configure`` or ``cmake``.
2222

23-
To avoid repeating this logic across packages, Spack provides specialized build system base classes that encapsulate these common patterns.
23+
To avoid repeating this logic across packages, Spack provides specialized build system base classes that encapsulate these common patterns.
2424
These classes help reduce boilerplate while still offering fine-grained control over the build process when needed.
2525

2626
In this section, we'll describe several of these build systems and show how they can be used to simplify and streamline package creation.
@@ -48,7 +48,7 @@ Package Class Hierarchy
4848
PackageBase -> PythonPackage [dir=back]
4949
}
5050

51-
The diagram above provides a high-level view of the class hierarchy and how each package class relates to the others.
51+
The diagram above provides a high-level view of the class hierarchy and how each package class relates to the others.
5252
Each build system specific class inherits from the ``PackageBase`` superclass.
5353

5454
The bulk of the common functionality, such as fetching sources, extracting them into a staging directory, and managing the install process, is implemented in the superclass.
@@ -236,13 +236,13 @@ Let's add in the rest of the package's details:
236236
:emphasize-lines: 10,11,13,14,18,20
237237
:linenos:
238238

239-
As previously mentioned, most packages that use a ``Makefile`` include hardcoded variables that must be edited.
240-
While this setup may be sufficient for basic use cases, it is often inflexible, especially when different compilers or build configurations are required.
239+
As previously mentioned, most packages that use a ``Makefile`` include hardcoded variables that must be edited.
240+
While this setup may be sufficient for basic use cases, it is often inflexible, especially when different compilers or build configurations are required.
241241
Spack is designed to support a wide range of compilers and platforms, and the ``MakefilePackage`` subclass helps accommodate that flexibility.
242242

243243
The ``MakefilePackage`` class simplifies the process of editing ``Makefiles`` through its overridable ``edit()`` method, which provides a hook for making in-place changes before the build begins.
244244

245-
As an example, consider the default ``Makefile`` provided with ``Bowtie``.
245+
As an example, consider the default ``Makefile`` provided with ``Bowtie``.
246246
Inspecting its contents reveals that ``CC`` and ``CXX`` are hardcoded to the GNU compilers:
247247

248248
.. code-block:: console

0 commit comments

Comments
 (0)