zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplified "Environment-Modules" section in getting started guide. (#6410)

Browse Source 
Fixes #2440

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

 - outdated / wrong suggestions as noted in #2440
 - uncommon setups that are better treated in a reference guide
This commit is contained in:
Massimiliano Culpo 2017-12-11 20:34:39 +01:00 committed by scheibelp
parent e83c3d1b6a
commit bd5d6b2bfa
1 changed files with 21 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
lib/spack/docs/getting_started.rst
View File

@ -926,75 +926,38 @@ Once ``curl`` has been installed, you can similarly install the others.
Environment Modules Environment Modules
""""""""""""""""""" """""""""""""""""""
In order to use Spack's generated environment modules, you must have In order to use Spack's generated module files, you must have
installed one of *Environment Modules* or *Lmod*. On many Linux installed ``environment-modules`` or ``lmod``. The simplest way
distributions, this can be installed from the vendor's repository. For to get the latest version of either of these tools is installing
example: ``yum install environment-modules`` (Fedora/RHEL/CentOS). If it as part of Spack's bootstrap procedure:
your Linux distribution does not have Environment Modules, Spack can
build it for you!
What follows are three steps describing how to install and use environment-modules with spack. .. code-block:: console
#. Install ``environment-modules``. $ spack bootstrap
* ``spack bootstrap`` will build ``environment-modules`` for you (and may build .. warning::
other packages that are useful to the operation of Spack) At the moment ``spack bootstrap`` is only able to install ``environment-modules``.
Extending its capabilities to prefer ``lmod`` where possible is in the roadmap,
and likely to happen before the next release.
* Install ``environment-modules`` using ``spack install`` with Alternatively, on many Linux distributions, you can install a pre-built binary
``spack install environment-modules~X`` (The ``~X`` variant builds without Xorg from the vendor's repository. On Fedora/RHEL/CentOS, for example, this can be
dependencies, but ``environment-modules`` works fine too.) done with the command:
#. Add ``modulecmd`` to ``PATH`` and create a ``module`` command. .. code-block:: console
* If you are using ``bash`` or ``ksh``, Spack can currently do this for you as well. $ yum install environment-modules
After installing ``environment-modules`` following the step
above, source Spack's shell integration script. This will automatically
detect the lack of ``modulecmd`` and ``module``, and use the installed
``environment-modules`` from ``spack bootstrap`` or ``spack install``.
.. code-block:: console
# For bash/zsh users Once you have the tool installed and available in your path, you can source
$ export SPACK_ROOT=/path/to/spack Spack's setup file:
$ . $SPACK_ROOT/share/spack/setup-env.sh
.. code-block:: console
* If you prefer to do it manually, you can activate with the following $ source share/spack/setup-env.sh
script (or apply the updates to your ``.bashrc`` file manually):
.. code-block:: sh This activates :ref:`shell support <shell-support>` and makes commands like
``spack load`` available for use.
TMP=`tempfile`
echo >$TMP
MODULE_HOME=`spack location --install-dir environment-modules`
MODULE_VERSION=`ls -1 $MODULE_HOME/Modules | head -1`
${MODULE_HOME}/Modules/${MODULE_VERSION}/bin/add.modules <$TMP
cp .bashrc $TMP
echo "MODULE_VERSION=${MODULE_VERSION}" > .bashrc
cat $TMP >>.bashrc
This is added to your ``.bashrc`` (or similar) files, enabling Environment
Modules when you log in.
#. Test that the ``module`` command is found with:
.. code-block:: console
$ module avail
If ``tcl`` 8.0 or later is installed on your system, you can prevent
spack from rebuilding ``tcl`` as part of the ``environment-modules`` dependency
stack by adding the following to your ``~/.spack/packages.yaml`` replacing
version 8.5 with whatever version is installed on your system:
.. code-block:: yaml
packages:
tcl:
paths:
tcl@8.5: /usr
buildable: False
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
Package Utilities Package Utilities