Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add minimal Spack spec for ACTS core #3638

Merged
merged 2 commits into from
Sep 23, 2024
Merged

docs: Add minimal Spack spec for ACTS core #3638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8086f1a
docs: Add minimal Spack spec for ACTS core
stephenswat Sep 23, 2024
878a30f
Merge branch 'main' into docs/core_spack
stephenswat Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/misc/spack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,30 @@ the environment every time you open a new shell.
With the Spack environment activated, you are ready to install ACTS'
dependencies. You can either do this manually, or you can rely on Spack's
definition of how to do this. To use the Spack definition, execute the
following command (tuned for ACTS version 36.1.0):
following command (tuned for ACTS version 36.1.0; make sure you update the
version number to match the version of ACTS you want to build):

```console
$ spack install --add --only dependencies "acts@36.1.0"
```

This specification will suffice to build the core ACTS library. If you want to
build ACTS plugins, you will need to add additional _variants_; the following
is a spec which can be used to build ACTS and all its plugins:

```console
$ spack install --add --only dependencies "acts@36.1.0+tgeo+geomodel+podio+edm4hep+examples+odd+fatras+json+dd4hep+geant4+fatras_geant4+hepmc3+pythia8+python+svg+traccc"
```

The string starting with `acts` in the command above is the so-called _spec_,
The string starting with `acts` in the commands above is the so-called _spec_,
and it consists of three parts. The first part is the name of the package,
which is `acts`. The second part is the version of the package, in this case
`36.1.0`; Spack will pull in a set of dependencies suitable for that given
version, so it is recommended to tune the version number to match the version
of ACTS you want to build. The final part is a series of variants, marked with
the `+` symbol. The command above allows you to build virtually all components
of ACTS, but it also pulls in a large number of dependencies. You can
optionally remove variants you do not need in order to speed up the Spack
build.
of ACTS, but it also pulls in a large number of dependencies. You can remove
variants you do not need in order to speed up the Spack build.

Once Spack has concretized and installed the ACTS dependencies, you can build
ACTS as normal using CMake.
Expand Down
Loading