README.md 5.98 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
[![MacOS Tests](https://github.com/spack/spack/workflows/macos%20tests/badge.svg)](https://github.com/spack/spack/actions)
[![Linux Tests](https://github.com/spack/spack/workflows/linux%20tests/badge.svg)](https://github.com/spack/spack/actions)
5
[![Linux Builds](https://github.com/spack/spack/workflows/linux%20builds/badge.svg)](https://github.com/spack/spack/actions)
6
[![macOS Builds (nightly)](https://github.com/spack/spack/workflows/macOS%20builds%20nightly/badge.svg?branch=develop)](https://github.com/spack/spack/actions?query=workflow%3A%22macOS+builds+nightly%22)
7
[![codecov](https://codecov.io/gh/spack/spack/branch/develop/graph/badge.svg)](https://codecov.io/gh/spack/spack)
8
[![Read the Docs](https://readthedocs.org/projects/spack/badge/?version=latest)](https://spack.readthedocs.io)
9
[![Slack](https://spackpm.herokuapp.com/badge.svg)](https://spackpm.herokuapp.com)
10

11
12
13
14
15
16
17
18
19
20
21
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
22
23

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

27
28
To install spack and your first package, make sure you have Python.
Then:
Todd Gamblin's avatar
Todd Gamblin committed
29

30
    $ git clone https://github.com/spack/spack.git
Todd Gamblin's avatar
Todd Gamblin committed
31
    $ cd spack/bin
32
    $ ./spack install zlib
Todd Gamblin's avatar
Todd Gamblin committed
33
34
35
36

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

37
38
[**Full documentation**](http://spack.readthedocs.io/) is available, or
run `spack help` or `spack help --all`.
39

40
41
42
43
44
45
46
47
Tutorial
----------------

We maintain a
[**hands-on tutorial**](http://spack.readthedocs.io/en/latest/tutorial.html).
It covers basic to advanced usage, packaging, developer features, and large HPC
deployments.  You can do all of the exercises on your own laptop using a
Docker container.
Todd Gamblin's avatar
Todd Gamblin committed
48

49
50
Feel free to use these materials to teach users at your organization
about Spack.
51

52
Community
53
54
------------------------

55
56
Spack is an open source project.  Questions, discussion, and
contributions are welcome. Contributions can be anything from new
57
packages to bugfixes, documentation, or even new core features.
58

59
Resources:
60

61
* **Slack workspace**: [spackpm.slack.com](https://spackpm.slack.com).
62
63
  To get an invitation, [**click here**](https://spackpm.herokuapp.com).
* **Mailing list**: [groups.google.com/d/forum/spack](https://groups.google.com/d/forum/spack)
64
65
* **Twitter**: [@spackpm](https://twitter.com/spackpm). Be sure to
  `@mention` us!
66

67
68
Contributing
------------------------
69
Contributing to Spack is relatively easy.  Just send us a
Todd Gamblin's avatar
Todd Gamblin committed
70
[pull request](https://help.github.com/articles/using-pull-requests/).
71
When you send your request, make ``develop`` the destination branch on the
72
[Spack repository](https://github.com/spack/spack).
73

74
Your PR must pass Spack's unit tests and documentation tests, and must be
75
[PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant.  We enforce
76
77
these guidelines with our CI process. To run these tests locally, and for 
helpful tips on git, see our
78
[Contribution Guide](http://spack.readthedocs.io/en/latest/contribution_guide.html).
Todd Gamblin's avatar
Todd Gamblin committed
79

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Spack's `develop` branch has the latest contributions. Pull requests
should target `develop`, and users who want the latest package versions,
features, etc. can use `develop`.

Releases
--------

For multi-user site deployments or other use cases that need very stable
software installations, we recommend using Spack's
[stable releases](https://github.com/spack/spack/releases).

Each Spack release series also has a corresponding branch, e.g.
`releases/v0.14` has `0.14.x` versions of Spack, and `releases/v0.13` has
`0.13.x` versions. We backport important bug fixes to these branches but
we do not advance the package versions or make other changes that would
change the way Spack concretizes dependencies within a release branch.
So, you can base your Spack deployment on a release branch and `git pull`
to get fixes, without the package churn that comes with `develop`.

See the [docs on releases](https://spack.readthedocs.io/en/latest/developer_guide.html#releases)
for more details.
101

102
103
104
105
106
107
108
Code of Conduct
------------------------

Please note that Spack has a
[**Code of Conduct**](.github/CODE_OF_CONDUCT.md). By participating in
the Spack community, you agree to abide by its rules.

Todd Gamblin's avatar
Todd Gamblin committed
109
110
Authors
----------------
111
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).
112

113
Spack was created by Todd Gamblin, tgamblin@llnl.gov.
114

115
116
117
118
119
120
121
122
123
### 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.

124
License
125
----------------
126
127
128
129
130
131
132
133
134
135
136
137

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.
138

139
SPDX-License-Identifier: (Apache-2.0 OR MIT)
140

141
LLNL-CODE-811652