6. Developing FCCSW

Page contributors

Valentin Volkl, Gerardo Ganis, Juraj Smiesko

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

Contents:

• 6.1. Github workflow and contribution guide
  • 6.1.1. Overview
  • 6.1.2. First time setup of git
  • 6.1.3. Generate and set up ssh keys for github
  • 6.1.4. Improving your git experience
  • 6.1.5. Development workflow
    • 6.1.5.1. Keeping your local repository up to date
    • 6.1.5.2. Contributing code
  • 6.1.6. Recommendations
    • 6.1.6.1. General recommendations
    • 6.1.6.2. Commit comments
    • 6.1.6.3. Cleaning history
    • 6.1.6.4. Pull requests
  • 6.1.7. Trouble-shooting
    • 6.1.7.1. When I try to push to the repository, I get an authentication error
    • 6.1.7.2. I have cloned with https and now I can’t push my changes, what do I do?
  • 6.1.8. Need help?
• 6.2. CMake guide for the FCC software
  • 6.2.1. Overview
  • 6.2.2. Quick start into building FCCSW
    • 6.2.2.1. Set up the environment
    • 6.2.2.2. Using the top-level Makefile
    • 6.2.2.3. Using plain CMake
  • 6.2.3. CMake example packages
  • 6.2.4. CMake in the FCC software framework
    • 6.2.4.1. Runtime Environment
  • 6.2.5. CTest in FCCSW
  • 6.2.6. Using an internal library
  • 6.2.7. Building a new Gaudi module
  • 6.2.8. Using an external library
    • 6.2.8.1. Customizing how CMake is run
• 6.3. Writing Gaudi Algorithms
  • 6.3.1. Getting Started
  • 6.3.2. Exercise: Adding an Algorithm
• 6.4. Developing DD4hep Detector models
• 6.5. Guide to the Transition of FCCSW to EDM4hep
  • 6.5.1. Technical Information
    • 6.5.1.1. Build System
    • 6.5.1.2. Component source Code
      • 6.5.1.2.1. Generation / MCParticles
    • 6.5.1.3. Job options
• 6.6. Writing documentation for the FCC Software
  • 6.6.1. Where to put documentation
  • 6.6.2. How to write Mardown
    • 6.6.2.1. Custom Admonitions
  • 6.6.3. When and how is the tutorials page updated?
  • 6.6.4. For website admins