docs: Add troubleshooting section for Spack

[stephenswat]

As @Cas1997 discovered, the DD4hep executables need some additional setup when using a Spack install. This commit adds documentation to the Spack page on how to do this, and on how to debug related issues.

Summary by CodeRabbit

• Documentation
  • Updated documentation for building with Spack, including new sections on running DD4hep and troubleshooting common issues.
  • Added detailed instructions for executing the necessary shell script after activating the Spack environment.
  • Introduced a "Troubleshooting" section addressing common errors related to DD4hep.

[coderabbitai]

Walkthrough

The documentation for building with Spack has been expanded to provide more comprehensive guidance for users. A new section on running DD4hep has been added, explaining how to properly initialize the environment by sourcing a specific shell script. A troubleshooting section has also been introduced, addressing potential issues users might encounter, particularly related to DD4hep factory detection.

Changes

File	Change Summary
docs/misc/spack.md	Added new sections: - "Running DD4hep" with initialization instructions - "Troubleshooting" with DD4hep factory-related error guidance

Poem

Spack's wisdom, now complete and bright, 🌟
DD4hep's path, no longer a plight 🛠️
Docs expanded with careful might
Troubleshooting errors in plain sight
Knowledge flows like the Force so light! 🧘‍♂️

Hmm, yes! 🍃

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[paulgessinger]

Actually, our CMake will produce a this_acts_withdeps.sh file in the build directory, that also calls this script, but also G4, and sets up ODD. So maybe we should recommend that instead of the dd4hep script directly?

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/misc/spack.md (1)

91-92: Expand the introduction, we should.

More context about troubleshooting section's purpose, helpful it would be.

Suggest this modification, I do:

-The following are some common problems you may encounter using Spack to build
-ACTS.
+The following section addresses common problems encountered when using Spack to build
+and run ACTS. If persist your issues do, seek guidance in the Spack channel on ACTS Mattermost, you should.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea831bf and e24cf23.

📒 Files selected for processing (1)

• docs/misc/spack.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/misc/spack.md

[style] ~65-~65: Consider a shorter alternative to avoid wordiness.
Context: ...ormal using CMake. ### Running DD4hep In order to run code depending on DD4hep, you may n...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (1)

docs/misc/spack.md (1)

96-104: Clear and helpful, this error description is.

Well structured the error documentation is. Example and solution, provided they are. Approve this section, I do.

[stephenswat]

Updated to mention this_acts_withdeps.sh!