Developing Key4hep

Sooner rather than later you will find it necessary write code for Key4hep. These pages cover some software development topics to remove any friction.

Contents:

• Github workflow and contribution guide
  • Overview
  • First time setup of git
  • Generate and set up ssh keys for github
  • Improving your git experience
  • Development workflow
    • Keeping your local repository up to date
    • Contributing code
  • Recommendations
    • General recommendations
    • Commit comments
    • Cleaning history
    • Pull requests
  • Trouble-shooting
    • When I try to push to the repository, I get an authentication error
    • I have cloned with https and now I can’t push my changes, what do I do?
  • Need help?
• CMake guide for Key4hep software
  • Overview
  • Quick start into building Key4hep Software
    • Set up the environment
    • Running CMake
    • Using your local installation
  • CMake example packages
  • Changing the CMake Configuration
    • Runtime Environment
  • CTest in Key4hep
    • Customizing how CMake is run
• Developing a single package
• Building Key4hep using Spack: For Developers
  • Spack set up
  • Developing a single package
    • Installing a local version with dev-build
    • Using the local version as dependency
    • More advanced usage
  • Developing multiple packages or dependencies of other packages
    • Using an environment to setup all dependencies
    • Environments and a development workflow
      • Adding another package to develop
• Writing Gaudi Algorithms
  • Gaudi
• Gaudi::Functional
  • Setup
  • Walkthrough of Functional Algorithms
  • The steering file
  • Initialize and finalize
  • Debugging: How to use GDB
  • Avoiding const in operator()

CMakeBuild.md