README.md 5.15 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
[![Build Status](https://travis-ci.com/spack/spack.svg?branch=develop)](https://travis-ci.com/spack/spack)
4
[![Linux Builds](https://github.com/spack/spack/workflows/linux%20builds/badge.svg)](https://github.com/spack/spack/actions)
5
[![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)
6
[![codecov](https://codecov.io/gh/spack/spack/branch/develop/graph/badge.svg)](https://codecov.io/gh/spack/spack)
7
[![Read the Docs](https://readthedocs.org/projects/spack/badge/?version=latest)](https://spack.readthedocs.io)
8
[![Slack](https://spackpm.herokuapp.com/badge.svg)](https://spackpm.herokuapp.com)
9

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

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

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

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

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

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

39
40
41
42
43
44
45
46
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
47

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

51
Community
52
53
------------------------

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

58
Resources:
59

60
* **Slack workspace**: [spackpm.slack.com](https://spackpm.slack.com).
61
62
  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)
63
64
* **Twitter**: [@spackpm](https://twitter.com/spackpm). Be sure to
  `@mention` us!
65

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

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

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

85
86
87
88
89
90
91
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
92
93
Authors
----------------
94
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).
95

96
Spack was created by Todd Gamblin, tgamblin@llnl.gov.
97

98
99
100
101
102
103
104
105
106
### 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.

107
License
108
----------------
109
110
111
112
113
114
115
116
117
118
119
120

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

122
SPDX-License-Identifier: (Apache-2.0 OR MIT)
123

124
LLNL-CODE-647188