Login

Kick-off Meeting: FCC Documentation and Training

→ Europe/Zurich
Alexander Moreno Briceño (Universidad Antonio Nariño), Michel Hernandez Villanueva (Brookhaven National Laboratory (US))
Description

Meetings to discuss FCC Software and Computing documentation and training events (tutorials, hackatons, etc)

live notes
FCC Documentation and Training
Zoom Meeting ID
62458967726
Host
Alexander Moreno Briceño
Useful links
Join via phone
Zoom URL
Hide

FCC Documentation and Training - June 26, 2026

Attending:

Present: Birgit, Brieuc, Juraj, Mathilde, Armin, Benedikt, Michel, Alex, Shreyas, Juan Miguel, Vitalii

Apologies/Contributing: Laurent, Sarah

Introduction, status and plans

  • Kick-off Meeting! We expect to build momentum and ramp up activities around docs and training
  • The Current Landscape: in good shape, still quite some work to do
    • Incomplete tutorials, move to EDM4HEP 1.0
  • Mandate for the group
  • Move from Pandoc 2.18 to Pandoc 3.10
    • In fact, it may not be needed at all - let’s test just removing it from the YAML
    • Ok, it is actually used. Any file with a line starting with ::: is treated as Pandoc-flavored Markdown
  • Should we run CI tests daily?
    • Daily for the nightlies
  • Coding guidelines
    • Should we start with key4hep?
    • Is it doable for all FCC?
    • It’s not a priority issue - first let’s focus in gathering the material under the same organization at GitHub
  • Tutorials: target audience, specific to events so far, for onboarding
  • Training surveys can monitor what are the needs of the FCC community
  • Attempt to institutionalize the “First Good” issue
  • List of previous workshops in the slides
  • Organize documentation and training hackathons, focus on specific topics in collaboration with other FCC working groups
  • Systematize FCC training events - a “checklist” for tutorials that help with the organization
  • FCC Training Recognition - Training is a volunteer basis-effort
    • Discuss how to recognize people that contribute
    • Git blame shows only one name - some work needed to find the original author
    • Add on top of pages the contributors (Michel and Alex taking care)
  • Gathering a list of mentors is a high-priority task
  • In the on-boarding, add general info about FCC organization, contact info, early career information

Action items

  • Update Pandoc to 3.10 (latest version)
  • Run the CI tests daily for the nightlies
  • Where to gather a list of mentors? - Contact info
  • Add contributors for the pages on top
  • Add explanation of concepts in distributed computing in the tutorials

FCCAnalyses in fcc-tutorials (Benedikt)

  • Benedikt acting as a newcomer (“guinea pig” for training) - did not follow a training event but self-onboarding
  • General overview of the content
    • Consistency: some sections quite verbose, others extremely concise; some key explanations found in late sections
    • Completeness: introduce some core concepts
  • Example of breaking change: EDM4HEP 1.0
  • Detached Analysis section, now dedicated chapter
    • Clear separation of production and analysis
  • Some updates in distributed computing
    • Relocated EventProducer - should be removed?
    • [Birgit] No one can use it without proper permissions, no benefit on keeping it in the tutorials
    • Make sure that the DIRAC part is complete and working, remove EventProducer (keeping elsewhere as documentation for Monte Carlo production managers)
  • What should go to tutorials, and what to (ILC)DIRAC documentation?
    • In the tutorial, at least we need to add the “first job submission” on DIRAC, and explain distributed computing concepts
    • Add links to DIRAC docs at the bottom
  • Some cleanup of the repository, reorganizing folder hierarchy to match Sphinx documentation
  • Didn’t touch full simulation
  • PR in fcc-tutorials #181
    • Please review!

Round table

BNL-CERN FCC School (Brieuc)

  • Software Tutorial in the BNL-CERN school on Physics at Future Colliders
  • Brieuc will lead the discussion on software
    • Lecture 1: pure software development (CI/CD, basics of key4hep)
    • Lecture 2: Reconstruction, Physics analyses, FCCAnalyses
    • Lecture 3 and 4: Sim and reconstruction
  • Discussion on how to deal with the simulation, as the hands-on will happen before the talk on detector simulation
  • It was requested to touch on FCC-hh analysis example
    • If FCC-hh included, we will need more tutors
  • Have you considered to include fast simulation?
    • In MC generation, fast simulation could be included on top
  • Hands-on for 2 hours is too tight
    • It is the best we could get
    • Could be possible to extend the tutorial? Depends if the room is booked afterwards
  • Stress on not making it copy-paste, but students really code
    • Provide the boilerplate, something that compiles, and the students need to fix the gaps
There are minutes attached to this event. Show them.