The FCC Starterkit

These are the lessons taught during the FCC Tutorials (the format is heavily inspired by the LHCb starterkit). If you’d like to join the next tutorial, visit the FCCSW website to find out when it will happen and how to sign up.

If you’d just like to learn about how to use the FCC software, read on!

Contents:

• 1. First Steps
  • 1.1. Pre-workshop checklist
    • 1.1.1. Checking the chosen resources
    • 1.1.2. Enabling the FCC software ecosystem from cvmfs
    • 1.1.3. Special notes or alternative cases / settings
  • 1.2. Running the software in SWAN notebooks
  • 1.3. Goals of the course
  • 1.4. An introduction to FCC Software
  • 1.5. Finding data in the Bookkeeping
    • 1.5.1. Gaining access permissions
    • 1.5.2. Finding Data
  • 1.6. Inspecting an FCC data file
    • 1.6.1. The events tree
    • 1.6.2. The metadata tree
  • 1.7. Tips and tricks
    • 1.7.1. Autocompletion using bash history
  • 1.8. Asking good questions
• 2. Generators, Fast Simulation and Analysis
  • 2.1. FCC: Getting started with event generation
    • 2.1.1. Overview
    • 2.1.2. Enabling FCCSW
    • 2.1.3. Generators
    • 2.1.4. Hands-on case study: ditau events with KKMCee, Pythia8 and Whizard
  • 2.2. FCC: Getting started with simulating events in Delphes
    • 2.2.1. Part I: Generate and simulate Events with DelphesEDM4Hep
  • 2.3. FCC: Getting started with analysing simulated events
    • 2.3.1. Part II: Analyse with FCCAnalyses
  • 2.4. FCC: tracking and vertexing example using specific flavour decays
    • 2.4.1. Installation of FCCAnalyses
    • 2.4.2. Building a custom sub-package in FCCAnalyses
    • 2.4.3. Reconstruction of the primary vertex and of primary tracks
    • 2.4.4. Reconstruction of displaced vertices in an exclusive decay chain: starting example
    • 2.4.5. Exercise: analysis of \(\tau \rightarrow 3 \mu\)
  • 2.5. FCCAnalyses: Common problems and solutions
    • 2.5.1. Prerequisites
    • 2.5.2. Overall organisation of analysis code (C++)
    • 2.5.3. Reading objects from EDM4HEP
    • 2.5.4. Association between RecoParticles and MonteCarloParticles
    • 2.5.5. Navigation through the history of the MonteCarloParticles
    • 2.5.6. Writing a new function
    • 2.5.7. Writing a new struct
    • 2.5.8. Writing a new namespace
    • 2.5.9. Writing your own analysis using the case-studies generator
  • 2.6. Central production of events
    • 2.6.1. Clone and initialisation
    • 2.6.2. Generate LHE files from gripacks
    • 2.6.3. Generate LHE files directly from MG5
    • 2.6.4. Generate STDHEP files directly from Whizard + Pythia6
    • 2.6.5. Generate EDM4hep files from the LHE and decay with Pythia8
    • 2.6.6. Generate EDM4hep files from STDHEP
    • 2.6.7. Generate EDM4hep files from Pythia8
    • 2.6.8. Expert mode
    • 2.6.9. Produce samples with EventProducer outside of official campaign
• 3. Full Detector Simulations
  • 3.1. FCCee: Full Simulation of CLD, the CLID detector for FCC
    • 3.1.1. Setting up the environment
    • 3.1.2. Generate some signal to process: taus from the particle gun
  • 3.2. FCCee: Full Simulation of IDEA Driftchamber
  • 3.3. Using Guinea-Pig to generate interaction region backgrounds
    • 3.3.1. Generating \(e^{+} e^{-}\) pairs with Guinea-Pig
    • 3.3.2. Generating large amounts of data with Guinea-Pig
    • 3.3.3. Analysing the data (only for ILCSOFT users)
    • 3.3.4. Tracking the pairs in the detector using Key4HEP
    • 3.3.5. GP production of \(\gamma\gamma\) hadrons
  • 3.4. Noble Liquid Calorimeter Full Simulation Exercise
    • 3.4.1. Setting up your environment
    • 3.4.2. Getting familiar with the detector geometry
    • 3.4.3. Running simple simulation and evaluating performance
    • 3.4.4. Changing the geometry
    • 3.4.5. Applying energy corrections
    • 3.4.6. Adding noise
    • 3.4.7. Preparing for the next tutorial
    • 3.4.8. Bonus exercise
  • 3.5. FCC-ee photon/pi0 discrimination using noble liquid calorimeter
    • 3.5.1. Installation of FCCAnalyses
    • 3.5.2. Build FCCAnalyses skeleton
    • 3.5.3. Get the highest energetic cluster
    • 3.5.4. Get the list of cells from the cluster
    • 3.5.5. Create sub-collection of cells
    • 3.5.6. Create collection of cells observables
    • 3.5.7. Adding the MVA inference
    • 3.5.8. Removing the last layers
    • 3.5.9. Compare the performance
  • 3.6. Changing geometry
    • 3.6.1. Setup
    • 3.6.2. Modify an existing XML file
    • 3.6.3. Overlap checking
    • 3.6.4. Modifying the ECAL
    • 3.6.5. Geometry driver modifications
    • 3.6.6. Final note
  • 3.7. Visualization
    • 3.7.1. Key4hep tool: geoDisplay
    • 3.7.2. Geant4
    • 3.7.3. Phoenix@FCC
• 4. Distributed computing
  • 4.1. Getting started with FCC distributed computing
    • 4.1.1. Registering to the FCC VO
    • 4.1.2. Enabling DIRAC
    • 4.1.3. The web portal
  • 4.2. FCC DIRAC example workflows
    • 4.2.1. Overview of the submission scripts
    • 4.2.2. Workflow 1
  • 4.3. Structure for /eos/experiment/fcc/prod
    • 4.3.1. Overview
• 5. Developing FCCSW
  • 5.1. Github workflow and contribution guide
    • 5.1.1. Overview
    • 5.1.2. First time setup of git
    • 5.1.3. Generate and set up ssh keys for github
    • 5.1.4. Improving your git experience
    • 5.1.5. Development workflow
    • 5.1.6. Recommendations
    • 5.1.7. Trouble-shooting
    • 5.1.8. Need help?
  • 5.2. CMake guide for the FCC software
    • 5.2.1. Overview
    • 5.2.2. Quick start into building FCCSW
    • 5.2.3. CMake example packages
    • 5.2.4. CMake in the FCC software framework
    • 5.2.5. CTest in FCCSW
    • 5.2.6. Using an internal library
    • 5.2.7. Building a new Gaudi module
    • 5.2.8. Using an external library
  • 5.3. Writing Gaudi Algorithms
    • 5.3.1. Getting Started
    • 5.3.2. Exercise: Adding an Algorithm
  • 5.4. Developing DD4hep Detector models
  • 5.5. Guide to the Transition of FCCSW to EDM4hep
    • 5.5.1. Technical Information
  • 5.6. Writing documentation for the FCC software
    • 5.6.1. Where to put documentation
    • 5.6.2. When and how is the documentation page updated?
    • 5.6.3. Structure of the content of the main page
    • 5.6.4. Running website generation locally
    • 5.6.5. For website admins
    • 5.6.6. Custom Admonitions
• 6. Contributing
  • 6.1. Getting Started
  • 6.2. Building the lessons
    • 6.2.1. Using venv (recommended)
    • 6.2.2. Using starterkit_ci

External links:

• FCCSW main page
• FCCAnalyses reference documentation
• Analysis essentials
• FCC software glossary