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.

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

docs: Add troubleshooting section for Spack #3881

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
28 changes: 28 additions & 0 deletions docs/misc/spack.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ 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.

### Running DD4hep

In order to run code depending on DD4hep, you may need to run an additional
shell script when you activate your Spack environment. This shell script is
called `thisdd4hep_only.sh` and resides in the binary directory of your Spack
view. An easy way to activate this shell script is to run the following
command:

```console
$ source $(dirname $(which ddsim))/thisdd4hep_only.sh
stephenswat marked this conversation as resolved.
Show resolved Hide resolved
```

## Build caches

Expand All @@ -74,3 +85,20 @@ at times be out of date. If you encounter any problems using Spack to build
ACTS, unofficial support is available in the
[#Spack](https://mattermost.web.cern.ch/acts/channels/spack) channel on the
ACTS Mattermost.

## Troubleshooting

The following are some common problems you may encounter using Spack to build
ACTS.

### DD4hep not finding factories

If you run into an error like the following, DD4hep is failing to find the
object files required to parse some its required factories. Remember to
initialize DD4hep as described in ["Running DD4hep"](#running-dd4hep):

```text
dd4hep: Failed to locate plugin to interprete files of type "lccdd" - no factory:lccdd_XML_reader.
No factory with name Create(lccdd_XML_reader) for type lccdd_XML_reader found.
Please check library load path and/or plugin factory name.
```
Loading