Skip to content

Commit

Permalink
SC17 specific edits
Browse files Browse the repository at this point in the history
  • Loading branch information
tgamblin authored and hauten committed Oct 30, 2019
1 parent b68f6ae commit c2d2341
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 38 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,13 @@
# <img src="https://cdn.rawgit.com/spack/spack/develop/share/spack/logo/spack-logo.svg" width="64" valign="middle" alt="Spack"/> Spack Tutorial

[![Read the Docs](https://readthedocs.org/projects/spack-tutorial/badge/?version=latest)](https://spack-tutorial.readthedocs.io)
[![Read the Docs](https://readthedocs.org/projects/spack-tutorial/badge/?version=sc17)](https://spack-tutorial.readthedocs.io)

Spack is a multi-platform package manager that builds and installs multiple versions and configurations of software. It works on Linux, macOS, and many supercomputers. Spack is non-destructive: installing a new version of a package does not break existing installations, so many configurations of the same package can coexist.

This repository houses Spack's [**hands-on tutorial**](https://spack-tutorial.readthedocs.io/en/latest/), which is a subset of Spack's [**full documentation**](https://spack.readthedocs.io/) (or you can run `spack help` or `spack help --all`).
This repository houses Spack's [**hands-on tutorial**](https://spack-tutorial.readthedocs.io/en/sc17/), which is a subset of Spack's [**full documentation**](https://spack.readthedocs.io/) (or you can run `spack help` or `spack help --all`).

This tutorial covers basic to advanced usage, packaging, developer features, and large HPC deployments. You can do all of the exercises on your own laptop using a Docker container. Feel free to use these materials to teach users at your organization about Spack.

## Updating the tutorial

1. Create a new branch named for the event/milestone that corresponds to the new version you want to create.
2. Upload screen shot of first slide (244px wide, .png) to [images directory](https://github.com/spack/spack-tutorial/tree/master/tutorial/images) following existing file-naming convention.
3. Upload PDF of slide deck to [slides directory](https://github.com/spack/spack-tutorial/tree/master/tutorial/slides) following existing file-naming convention.
4. Update [index.rst](https://github.com/spack/spack-tutorial/blob/master/index.rst) with event name and date; full citation; and file paths for image and PDF.
5. Update this README (lines 3 and 7) with link to new version's URL.
6. Build docs locally.
7. Push changes to GitHub and active new tag/version on Read the Docs.
8. Build new version on Read the Docs.

## License

Spack is distributed under the terms of both the MIT license and the Apache License (Version 2.0). Users may choose either license, at their option.
Expand Down
37 changes: 12 additions & 25 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@
Tutorial: Spack 101
===================

This is a full-day introduction to Spack with lectures and live demos.
It was last presented at the `Practice and Experience in Advanced
Research Computing Conference (PEARC19)
<https://www.pearc19.pearc.org/>`_ on July 31, 2019.
This is a full day introduction to Spack with lectures and live demos. It
was presented as a tutorial at `Supercomputing 2017
<http://sc17.supercomputing.org>`_ on November 13, 2017.

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
Expand All @@ -22,37 +21,25 @@ Spack is used in practice.

.. rubric:: Slides

.. image:: tutorial/images/pearc19-tutorial-slide-preview.png
.. image:: tutorial/images/sc17-tutorial-slide-preview.png
:height: 72px
:align: left
:alt: Slide Preview

:download:`Download Slides <tutorial/slides/spack-pearc19-tutorial-slides.pdf>`.
:download:`Download Slides <tutorial/slides/Spack-SC17-Tutorial.pdf>`.

**Full citation:** Levi Baber, Gregory Becker, Adam J. Stewart, and Todd
Gamblin. Managing HPC Software Complexity with Spack. Tutorial presented
at the Practice and Experience in Advanced Research Computing Conference
(PEARC19). July 31, 2019. Chicago, IL, USA.
**Full citation:** Todd Gamblin, Massimiliano Culpo, Gregory Becker, Matt
Legendre, Greg Lee, Elizabeth Fischer, and Benedikt Hegner.
`Managing HPC Software Complexity with Spack
<https://sc17.supercomputing.org/index.html%3Fpost_type=page&p=5407&id=tut151&sess=sess233.html>`_.
Tutorial presented at Supercomputing 2017. November 13, 2017, Denver, CO, USA.

.. _live-demos:

.. rubric:: Live Demos

We provide scripts that take you step-by-step through basic Spack tasks.
They correspond to sections in the slides above. You can use one of the
following methods to run through the scripts:

1. We provide the `spack/tutorial
<https://hub.docker.com/r/spack/tutorial>`_ container image on
Docker Hub that you can use to do the tutorial on your local
machine. You can invoke ``docker run -it spack/tutorial`` to start
using the container.

2. When we host the tutorial, we also provision VM instances in `AWS
<https://aws.amazon.com/>`_, so that users who are unfamiliar with
Docker can simply log into a VPM to do the demo exercises.

You should now be ready to run through our demo scripts:
These scripts will take you step-by-step through basic Spack tasks. They
correspond to sections in the slides above.

1. :ref:`basics-tutorial`
2. :ref:`configs-tutorial`
Expand Down

0 comments on commit c2d2341

Please sign in to comment.