spack / spack/spack-tutorial

First mention of "spack install netlib-scalapack ^openmpi ^netlib-lapack" does not state not to run command.

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
52
Forks
38
Avg merge
9d 17h
Merged PRs (30d)
8

Description

As I go along this tutorial (which is awesome!), I copy-paste most of the commands that I encounter to work along inside my own spack installation. When I copy-paste this line "spack install netlib-scalapack ^openmpi ^netlib-lapack" from here it fails with an error. After some digging I found out that this is the expected behavior and should only be encountered later in the tutorial.

I guess a note saying "don't copy-paste these commands here" right in front of this would help:
$ spack install netlib-scalapack ^openmpi ^openblas
$ spack install netlib-scalapack ^mpich ^openblas
$ spack install netlib-scalapack ^openmpi ^netlib-lapack
$ spack install netlib-scalapack ^mpich ^netlib-lapack
$ spack install py-scipy ^openblas

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the tutorial_modules section linked in the issue and inspect the five Spack install commands before the advanced packaging section. Add a clear note that these commands should not be copied and run at that point, then render or preview the tutorial to confirm the warning appears immediately before them.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.