763b35a2e0
The import-check action now presents problematic import statements introduced by the PR better. The idea is roughly: * Let (V₁, E₁) be the graph of modules as vertices and import statements as edges before the change * Let (V₂, E₂) be the graph after the code change, which is typically a small perturbation of (V₁, E₁). * X₁ = FAS(V₁, E₁) is the feedback arc set before (a minimal set of edges to delete to make it acyclic) * X₂ = FAS(V₂, E₂ ∖ X₁) is the feedback arc set after deletion of the minimal set of edges that made the old graph acyclic. * X₃ = FAS(V₂, E₂) is the feedback arc set after Previously I displayed X₁ and X₃ and users had to diff themselves. Now, I'm showing X₂, which is a small set, typically directly related to code changes. However, it can be that a small code change adding say 2 problematic imports creates a completely different solution X₃ that only requires deletion of just 1 different import. In that case the user is informed that they can potentially do less work. So for PR #48784 the output is now: > The overall number of problematic import statements increased by 1 from 31 to 32. > This is likely a direct consequence of the following import statements: > > ``` > spack/config imports: spack.spec, spack.util.path, spack.util.remote_file_cache > ``` > > However, instead of removing 3 import statements, it is sufficient to remove only 1 > import statement from the following list: > > ``` > spack/concretize imports: spack.bootstrap, spack.solver.asp > spack/environment imports: spack.bootstrap, spack.environment > spack/fetch_strategy imports: spack.version.git_ref_lookup > spack/install_test imports: spack.build_environment, spack.package_base > spack/modules imports: spack.modules > spack/platforms imports: spack.config > spack/relocate imports: spack.bootstrap > spack/repo imports: spack.package_base, spack.patch, spack.tag > spack/spec imports: spack.binary_distribution, spack.compiler, spack.compilers, spack.concretize, spack.environment, spack.hash_types, spack.provider_index, spack.repo, spack.spec_parser, spack.store, spack.traverse, spack.variant, spack.version.git_ref_lookup > spack/subprocess_context imports: spack.environment > spack/util/gpg imports: spack.bootstrap > spack/util/package_hash imports: spack.package_base > spack/util/path imports: spack.config, spack.environment > spack/util/remote_file_cache imports: spack.util.web > ``` from which the user can figure out that `spack/util/remote_file_cache imports: spack.util.web` is the "bottleneck" now. |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| bin | ||
| etc/spack/defaults | ||
| lib/spack | ||
| share/spack | ||
| var/spack | ||
| .codecov.yml | ||
| .dockerignore | ||
| .flake8 | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .readthedocs.yml | ||
| CHANGELOG.md | ||
| CITATION.cff | ||
| COPYRIGHT | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| NOTICE | ||
| pyproject.toml | ||
| pytest.ini | ||
| README.md | ||
| SECURITY.md | ||
Spack is a multi-platform package manager that builds and installs multiple versions and configurations of software. It works on Linux, macOS, Windows, 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.
See the Feature Overview for examples and highlights.
To install spack and your first package, make sure you have Python & Git. Then:
$ git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git
$ cd spack/bin
$ ./spack install zlib
Tip
-c feature.manyFiles=trueimproves git's performance on repositories with 1,000+ files.
--depth=2prunes the git history to reduce the size of the Spack installation.
Documentation
Full documentation is available, or
run spack help or spack help --all.
For a cheat sheet on Spack syntax, run spack help --spec.
Tutorial
We maintain a hands-on tutorial. 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.
Feel free to use these materials to teach users at your organization about Spack.
Community
Spack is an open source project. Questions, discussion, and contributions are welcome. Contributions can be anything from new packages to bugfixes, documentation, or even new core features.
Resources:
- Slack workspace: spackpm.slack.com. To get an invitation, visit slack.spack.io.
- Matrix space: #spack-space:matrix.org: bridged to Slack.
- Github Discussions: for Q&A and discussions. Note the pinned discussions for announcements.
- X: @spackpm. Be sure to
@mentionus! - Mailing list: groups.google.com/d/forum/spack: only for announcements. Please use other venues for discussions.
Contributing
Contributing to Spack is relatively easy. Just send us a
pull request.
When you send your request, make develop the destination branch on the
Spack repository.
Your PR must pass Spack's unit tests and documentation tests, and must be PEP 8 compliant. We enforce these guidelines with our CI process. To run these tests locally, and for helpful tips on git, see our Contribution Guide.
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.
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.
The latest release is always available with the releases/latest tag.
See the docs on releases for more details.
Code of Conduct
Please note that Spack has a Code of Conduct. By participating in the Spack community, you agree to abide by its rules.
Authors
Many thanks go to Spack's contributors.
Spack was created by Todd Gamblin, tgamblin@llnl.gov.
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. In Supercomputing 2015 (SC’15), Austin, Texas, November 15-20 2015. LLNL-CONF-669890.
On GitHub, you can copy this citation in APA or BibTeX format via the "Cite this repository"
button. Or, see the comments in CITATION.cff for the raw BibTeX.
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