README.md 4.19 KB
Newer Older
Todd Gamblin's avatar
Todd Gamblin committed
1
2
![image](share/spack/logo/spack-logo-text-64.png "Spack")
============
Todd Gamblin's avatar
Todd Gamblin committed
3

Todd Gamblin's avatar
Todd Gamblin committed
4
[![Build Status](https://travis-ci.org/LLNL/spack.svg?branch=develop)](https://travis-ci.org/LLNL/spack)
5
[![Coverage Status](https://coveralls.io/repos/github/LLNL/spack/badge.svg?branch=develop)](https://coveralls.io/github/LLNL/spack?branch=develop)
6

Todd Gamblin's avatar
Todd Gamblin committed
7
8
9
10
11
12
13
14
15
16
17
18
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 are
Jeff Squyres's avatar
Jeff Squyres committed
19
written in pure Python, and specs allow package authors to write a
Todd Gamblin's avatar
Todd Gamblin committed
20
21
22
single build script for many different builds of the same package.

See the
23
[Feature Overview](http://software.llnl.gov/spack/features.html)
Todd Gamblin's avatar
Todd Gamblin committed
24
25
26
27
for examples and highlights.

To install spack and install your first package:

28
    $ git clone https://github.com/llnl/spack.git
Todd Gamblin's avatar
Todd Gamblin committed
29
30
31
32
33
34
    $ cd spack/bin
    $ ./spack install libelf

Documentation
----------------

35
[**Full documentation**](http://software.llnl.gov/spack) for Spack is
36
37
38
39
40
41
42
the first place to look.

See also:
  * [Technical paper](http://www.computer.org/csdl/proceedings/sc/2015/3723/00/2807623.pdf) and
    [slides](https://tgamblin.github.io/files/Gamblin-Spack-SC15-Talk.pdf) on Spack's design and implementation.
  * [Short presentation](https://tgamblin.github.io/files/Gamblin-Spack-Lightning-Talk-BOF-SC15.pdf) from the *Getting Scientific Software Installed* BOF session at Supercomputing 2015.

Todd Gamblin's avatar
Todd Gamblin committed
43

44
Get Involved!
45
46
------------------------

47
48
49
50
51
52
53
Spack is an open source project.  Questions, discussion, and
contributions are welcome. Contributions can be anything from new
packages to bugfixes, or even new core features.

### Mailing list

If you are interested in contributing to spack, the first step is to
54
55
join the mailing list.  We're using a Google Group for this, and you
can join it here:
56

57
  * [Spack Google Group](https://groups.google.com/d/forum/spack)
58

59
60
### Contributions

Todd Gamblin's avatar
Todd Gamblin committed
61
62
Contributing to Spack is relatively.  Just send us a
[pull request](https://help.github.com/articles/using-pull-requests/).
63
64
When you send your request, make ``develop`` the destination branch on the
[Spack repository](https://github.com/LLNL/spack).
65

Todd Gamblin's avatar
Todd Gamblin committed
66
Before you send a PR, your code should pass the following checks:
67

Todd Gamblin's avatar
Todd Gamblin committed
68
69
70
71
72
73
74
75
76
77
78
* Your contribution will need to pass the `spack test` command.
  Run this before submitting your PR.

* Also run the `share/spack/qa/run-flake8` script to check for PEP8 compliance.
  To encourage contributions and readability by a broad audience,
  Spack uses the [PEP8](https://www.python.org/dev/peps/pep-0008/) coding
  standard with [a few exceptions](https://github.com/LLNL/spack/blob/develop/.flake8).

We enforce these guidelines with [Travis CI](https://travis-ci.org/LLNL/spack).

Spack uses a rough approximation of the [Git
79
80
81
82
83
84
Flow](http://nvie.com/posts/a-successful-git-branching-model/)
branching model.  The ``develop`` branch contains the latest
contributions, and ``master`` is always tagged and points to the
latest stable release.


Todd Gamblin's avatar
Todd Gamblin committed
85
86
Authors
----------------
87
Many thanks go to Spack's [contributors](https://github.com/llnl/spack/graphs/contributors).
88
89

Spack was originally written by Todd Gamblin, tgamblin@llnl.gov.
90

91
92
93
94
95
96
97
98
99
### Citing Spack

If you are referencing Spack in a publication, please cite the following paper:

 * Todd Gamblin, Matthew P. LeGendre, Michael R. Collette, Gregory L. Lee,
   Adam Moody, Bronis R. de Supinski, and W. Scott Futral.
   [**The Spack Package Manager: Bringing Order to HPC Software Chaos**](http://www.computer.org/csdl/proceedings/sc/2015/3723/00/2807623.pdf).
   In *Supercomputing 2015 (SC’15)*, Austin, Texas, November 15-20 2015. LLNL-CONF-669890.

100
101
102
103
104
105
Release
----------------
Spack is released under an LGPL license.  For more details see the
LICENSE file.

``LLNL-CODE-647188``