Skip to content
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

Merged

Conversation

alalazo
Copy link
Member

@alalazo alalazo commented Nov 22, 2017

fixes #2440

The "Getting started" guide should be short and sweet. This commit simplifies the "Environment-Modules" section pruning:

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
@alalazo alalazo added documentation Improvements or additions to documentation ready labels Nov 22, 2017
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
Copy link
Member

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?

Copy link
Member Author

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!


.. code-block:: sh
$ spack install lmod
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

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)

Copy link
Member Author

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. 😏

@alalazo
Copy link
Member Author

alalazo commented Nov 22, 2017

@ax3l done

@alalazo
Copy link
Member Author

alalazo commented Dec 7, 2017

@adamjstewart @tgamblin @scheibelp ping

@scheibelp scheibelp merged commit bd5d6b2 into spack:develop Dec 11, 2017
@scheibelp
Copy link
Member

Thanks!

@alalazo alalazo deleted the documentation/environment-modules branch December 12, 2017 07:08
ch741 pushed a commit to ch741/spack that referenced this pull request Apr 20, 2018
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Instructions on setting up environment-modules need update for macOS
4 participants