summaryrefslogtreecommitdiff
path: root/lib/spack/docs/getting_started.rst
blob: a28883259fa7745f2e21089d3a33864e548f6af2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
Getting Started
====================

Download
--------------------

Getting spack is easy.  You can clone it from the `github repository
<https://github.com/scalability-llnl/spack>`_ using this command:

.. code-block:: sh

   $ git clone https://github.com/scalability-llnl/spack.git

This will create a directory called ``spack``.  We'll assume that the
full path to this directory is in some environment called
``SPACK_HOME``.  Add ``$SPACK_HOME/bin`` to your path and you're ready
to go:

.. code-block:: sh

   $ export PATH=spack/bin:$PATH
   $ spack install libelf

In general, most of your interactions with Spack will be through the
``spack`` command.


Install
--------------------

You don't need to install Spack; it's ready to run as soon as you
clone it from git.

You may want to run it out of a prefix other than the git repository
you cloned.  The ``spack bootstrap`` command provides this
functionality.  To install spack in a new directory, simply type:

.. code-block:: sh

    $ spack bootstrap /my/favorite/prefix

This will install a new spack script in /my/favorite/prefix/bin, which
you can use just like you would the regular spack script.  Each copy
of spack installs packages into its own ``$PREFIX/opt`` directory.