README.md 6.01 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
[![Unit Tests](https://github.com/spack/spack/workflows/linux%20tests/badge.svg)](https://github.com/spack/spack/actions)
4
[![Bootstrapping](https://github.com/spack/spack/actions/workflows/bootstrap.yml/badge.svg)](https://github.com/spack/spack/actions/workflows/bootstrap.yml)
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://slack.spack.io/badge.svg)](https://slack.spack.io)
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
谭九鼎's avatar
谭九鼎 committed
23
[Feature Overview](https://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
----------------

谭九鼎's avatar
谭九鼎 committed
36
[**Full documentation**](https://spack.readthedocs.io/) is available, or
37
run `spack help` or `spack help --all`.
38

39 40
For a cheat sheet on Spack syntax, run `spack help --spec`.

41 42 43 44
Tutorial
----------------

We maintain a
谭九鼎's avatar
谭九鼎 committed
45
[**hands-on tutorial**](https://spack.readthedocs.io/en/latest/tutorial.html).
46 47 48
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
49

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

53
Community
54 55
------------------------

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

60
Resources:
61

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

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

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

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
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`.

100 101
The latest release is always available with the `releases/latest` tag.

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

105 106 107 108 109 110 111
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
112 113
Authors
----------------
114
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).
115

116
Spack was created by Todd Gamblin, tgamblin@llnl.gov.
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.
谭九鼎's avatar
谭九鼎 committed
124
   [**The Spack Package Manager: Bringing Order to HPC Software Chaos**](https://www.computer.org/csdl/proceedings/sc/2015/3723/00/2807623.pdf).
125 126
   In *Supercomputing 2015 (SC’15)*, Austin, Texas, November 15-20 2015. LLNL-CONF-669890.

127
License
128
----------------
129 130 131 132 133 134 135 136 137 138 139 140

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

142
SPDX-License-Identifier: (Apache-2.0 OR MIT)
143

144
LLNL-CODE-811652