Skip to content

spack/spack-packages

Spack

Documentation Status Slack Matrix

Getting Started   •   Community   •   Packaging Guide   •   Spack

This is the default Spack package repository, which contains the set of packages maintained by the Spack community. In Spack v1.0 and later, the repository here is automatically added to the Spack configuration.

Community

Spack is an open source project. Questions, discussion, and contributions are welcome.

Structure of this repo

This repository does not look like the original Spack package repositories. Its structure has been renovated a bit to make it work better with modern python tooling. The repo looks like this:

spack-packages/
    repos/                          # add this to PYTHONPATH for your editor
        spack_repo/                 # dedicated python package for spack repositories
            builtin/                # namespace of this package repository
                build_systems/      # build_systems: common base classes used by many packages
                packages/           # This is where all the package.py files go
                    <PKG_NAME>/     # e.g., hdf5, zlib, mfem
                        package.py  # actual package recipes

The new repository structure is designed around several goals:

  1. Make it easy to add the repository to PYTHONPATH;
  2. Allow common python code like build_systems to live in the package repo, not core Spack; and
  3. Allow multiple reositories (e.g. something in addition to builtin to live in the same git repository.

If you use an editor like vscode, you should be able to point it directly to the repos/ directory and have the editor understand the package code.

Contributing

To contribute, simply make a pull request to this repository with your package changes. We run continuous integration on this repository to test builds of a large number of Spack packages.

If you want to test your package changes locally before submitting a pull request, simply change Spack's default package repo from the default cache location to the full path to your local git clone:

spack repo set --destination /path/to/local/spack-packages builtin

$spack can be used to form a relative path to your Spack root directory.

If you are migrating your pull requests from github.com/spack/spack, it is recommended to use the the migration tool.

Searching Spack packages

You can query the packages built in this repository by visiting packages.spack.io.

Binary builds of Spack packages

The packages we build in CI here are available as Spack build caches. You can search hosted binaries at cache.spack.io.

License

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, LICENSE-APACHE, COPYRIGHT, and NOTICE for details.

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

LLNL-CODE-811652