README.md 5.09 KB
Newer Older
1
# <img src="https://cdn.rawgit.com/spack/spack/develop/share/spack/logo/spack-logo.svg" width="64" valign="middle" alt="Spack"/> Spack
Todd Gamblin's avatar
Todd Gamblin committed
2

3
4
[![Build Status](https://travis-ci.org/spack/spack.svg?branch=develop)](https://travis-ci.org/spack/spack)
[![codecov](https://codecov.io/gh/spack/spack/branch/develop/graph/badge.svg)](https://codecov.io/gh/spack/spack)
5
[![Read the Docs](https://readthedocs.org/projects/spack/badge/?version=latest)](https://spack.readthedocs.io)
6
[![Slack](https://spackpm.herokuapp.com/badge.svg)](https://spackpm.herokuapp.com)
7

8
9
10
11
12
13
14
15
16
17
18
Spack is a multi-platform package manager that builds and installs
multiple versions and configurations of software. It works on Linux,
macOS, and many supercomputers. Spack is non-destructive: installing a
new version of a package does not break existing installations, so many
configurations of the same package can coexist.

Spack offers a simple "spec" syntax that allows users to specify versions
and configuration options. Package files are written in pure Python, and
specs allow package authors to write a single script for many different
builds of the same package.  With Spack, you can build your software
*all* the ways you want to.
Todd Gamblin's avatar
Todd Gamblin committed
19
20

See the
Ian Lee's avatar
Ian Lee committed
21
[Feature Overview](http://spack.readthedocs.io/en/latest/features.html)
Todd Gamblin's avatar
Todd Gamblin committed
22
23
for examples and highlights.

24
25
To install spack and your first package, make sure you have Python.
Then:
Todd Gamblin's avatar
Todd Gamblin committed
26

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

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

Todd Gamblin's avatar
Todd Gamblin committed
34
[**Full documentation**](http://spack.readthedocs.io/) for Spack is
35
36
the first place to look.

37
38
39
40
Try the
[**Spack Tutorial**](http://spack.readthedocs.io/en/latest/tutorial.html),
to learn how to use spack, write packages, or deploy packages for users
at your site.
Todd Gamblin's avatar
Todd Gamblin committed
41

42
43
44
45
46
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.

47
Get Involved!
48
49
------------------------

50
51
52
53
54
55
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

56
57
If you are interested in contributing to spack, join the mailing list.
We're using Google Groups for this:
58

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

61
62
63
64
65
66
67
68
69
### Slack channel

Spack has a Slack channel where you can chat about all things Spack:

  * [Spack on Slack](https://spackpm.slack.com)

[Sign up here](https://spackpm.herokuapp.com) to get an invitation mailed
to you.

70
71
72
73
74
75
### Twitter

You can follow [@spackpm](https://twitter.com/spackpm) on Twitter for
updates. Also, feel free to `@mention` us in in questions or comments
about your own experience with Spack.

76
77
### Contributions

78
Contributing to Spack is relatively easy.  Just send us a
Todd Gamblin's avatar
Todd Gamblin committed
79
[pull request](https://help.github.com/articles/using-pull-requests/).
80
When you send your request, make ``develop`` the destination branch on the
81
[Spack repository](https://github.com/spack/spack).
82

83
Your PR must pass Spack's unit tests and documentation tests, and must be
84
[PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant.  We enforce
85
these guidelines with [Travis CI](https://travis-ci.org/spack/spack).  To
86
run these tests locally, and for helpful tips on git, see our
87
[Contribution Guide](http://spack.readthedocs.io/en/latest/contribution_guide.html).
Todd Gamblin's avatar
Todd Gamblin committed
88

89
90
Spack uses a rough approximation of the
[Git Flow](http://nvie.com/posts/a-successful-git-branching-model/)
91
branching model.  The ``develop`` branch contains the latest
92
93
contributions, and ``master`` is always tagged and points to the latest
stable release.
94

Todd Gamblin's avatar
Todd Gamblin committed
95
96
Authors
----------------
97
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).
98

99
Spack was created by Todd Gamblin, tgamblin@llnl.gov.
100

101
102
103
104
105
106
107
108
109
### 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.

110
License
111
----------------
112
113
114
115
116
117
118
119
120
121
122
123

Spack is distributed under the terms of both the MIT license and the
Apache License (Version 2.0). Users may choose either license, at their
option.

All new contributions must be made under both the MIT and Apache-2.0
licenses.

See [LICENSE-MIT](https://github.com/spack/spack/blob/develop/LICENSE-MIT),
[LICENSE-APACHE](https://github.com/spack/spack/blob/develop/LICENSE-APACHE),
[COPYRIGHT](https://github.com/spack/spack/blob/develop/COPYRIGHT), and
[NOTICE](https://github.com/spack/spack/blob/develop/NOTICE) for details.
124
125

``LLNL-CODE-647188``
126
127

![Analytics](https://ga-beacon.appspot.com/UA-101208306-3/welcome-page?pixel)