index.rst 1.8 KB
Newer Older
Todd Gamblin's avatar
Todd Gamblin committed
1
2
3
4
5
.. Spack documentation master file, created by
   sphinx-quickstart on Mon Dec  9 15:32:41 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Todd Gamblin's avatar
Todd Gamblin committed
6
Spack Documentation
Todd Gamblin's avatar
Todd Gamblin committed
7
8
=================================

Todd Gamblin's avatar
Todd Gamblin committed
9
10
11
12
13
14
15
16
17
18
19
20
Spack is a package management tool designed to support multiple
versions and configurations of software on a wide variety of platforms
and environments.  It was designed for large supercomputing centers,
where many users and application teams share common installations of
software on clusters with exotic architectures, using libraries that
do not have a standard ABI.  Spack is non-destructive: installing a
new version does not break existing installations, so many
configurations can coexist on the same system.

Most importantly, Spack is *simple*.  It offers a simple *spec* syntax
so that users can specify versions and configuration options
concisely.  Spack is also simple for package authors: package files
Todd Gamblin's avatar
Todd Gamblin committed
21
22
are writtin in pure Python, and specs allow package authors to
maintain a single file for many different builds of the same package.
Todd Gamblin's avatar
Todd Gamblin committed
23
24

See the :doc:`features` for examples and highlights.
Todd Gamblin's avatar
Todd Gamblin committed
25

Todd Gamblin's avatar
Todd Gamblin committed
26
Get spack from the `github repository
27
<https://github.com/llnl/spack>`_ and install your first
Todd Gamblin's avatar
Todd Gamblin committed
28
package:
Todd Gamblin's avatar
Todd Gamblin committed
29
30
31

.. code-block:: sh

32
   $ git clone https://github.com/llnl/spack.git
Todd Gamblin's avatar
Todd Gamblin committed
33
   $ cd spack/bin
Todd Gamblin's avatar
Todd Gamblin committed
34
   $ ./spack install libelf
Todd Gamblin's avatar
Todd Gamblin committed
35
36
37
38
39
40

If you're new to spack and want to start using it, see :doc:`getting_started`,
or refer to the full manual below.

Table of Contents
---------------------
Todd Gamblin's avatar
Todd Gamblin committed
41
42
43
44

.. toctree::
   :maxdepth: 2

Todd Gamblin's avatar
Todd Gamblin committed
45
46
47
48
   features
   getting_started
   basic_usage
   packaging_guide
49
   mirrors
Todd Gamblin's avatar
Todd Gamblin committed
50
51
   site_configuration
   developer_guide
52
   command_index
53
   package_list
Todd Gamblin's avatar
Todd Gamblin committed
54
   API Docs <spack>
Todd Gamblin's avatar
Todd Gamblin committed
55
56
57
58
59
60
61

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`