-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Simplified "Environment-Modules" section in getting started guide. #6410
Simplified "Environment-Modules" section in getting started guide. #6410
Conversation
fixes spack#2440 The "Getting started" guide should be short and sweet. This commit simplifies the "Environment-Modules" section pruning: - outdated / wrong suggestions as noted in spack#2440 - uncommon setups that are better treated in a reference guide
lib/spack/docs/getting_started.rst
Outdated
your Linux distribution does not have Environment Modules, Spack can | ||
build it for you! | ||
In order to use Spack's generated module files, you must have | ||
installed one of *Environment Modules* or *Lmod*. The preferred method |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is "one of" really necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't touch this sentence, but I agree - we can remove that!
lib/spack/docs/getting_started.rst
Outdated
|
||
.. code-block:: sh | ||
$ spack install lmod |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't we just advertise spack bootstrap
here? It will install a proper module system and all other missing dependencies, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am hesitant for only one reason: spack bootstrap
installs environment-modules
at the moment. This means that it won't work out of the box for anybody who wants to use Lmod module hierarchies. Maybe you're right and we should advertize only spack bootstrap
, and extend it later to prefer lmod
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One off-topic question: if spack install lmod
is enough to make lmod
known to spack, shouldn't spack install gcc@5.4.0
be enough to add it to compilers.yaml
automatically? :) #5101 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ax3l I should have more time to devote to Spack's development going to the end of the year. Simplify the management of compilers is on the radar. 😏
@ax3l done |
Thanks! |
…pack#6410) Fixes spack#2440 The "Getting started" guide should be short and sweet. This commit simplifies the "Environment-Modules" section pruning: - outdated / wrong suggestions as noted in spack#2440 - uncommon setups that are better treated in a reference guide
fixes #2440
The "Getting started" guide should be short and sweet. This commit simplifies the "Environment-Modules" section pruning: