refactor tutorial structure and update for recent EDM4hep changes#181
refactor tutorial structure and update for recent EDM4hep changes#181bndikt wants to merge 4 commits into
Conversation
- added relative path to newly added and updated histmaker_ttmm.py file, which now works with files created using latest edm4hep
- reorganize directory structure to reflect Sphinx docs structure - add FCCAnalyses scripts for users to download - add links to newly generated ROOT files for running analyses locally - update analysis scripts for EDM4hep compatibility changes
…first but not complete update of description; minor rewordings
|
Hi, maybe the order of the top level sections should be flipped a bit. "Analysis" after Full Sim? Also, I would eliminate "FCC", so from "Analysis at FCC" to "Analysis". |
I agree with both. There are probably dozens of improvements at this or higher level of severity though. Maybe we should have a dedicated discussion to decide on the overall structure soon, down to the level of definitive naming of each chapter/section/subsection. Starting from there, we could start more detailed work on the content of the individual sections. I've tried to clean up the folder hierarchy and content quite a bit - maybe this commit could serve as a good starting point (rather than being the final version). |
Summary
This PR performs a substantial cleanup and reorganization of the FCC SW tutorial documentation sources used to build the Sphinx documentation.
The changes are split into two main categories:
Documentation structure refactor
2. Generators, Fast Simulation and Analysis).md)Content updates for recent EDM4hep changes
EDM4hepFCCAnalysesandEDM4hepMotivation
The previous documentation structure had diverged from the logical structure presented in the generated Sphinx documentation, making maintenance and navigation increasingly difficult.
At the same time, recent
EDM4hepupdates introduced incompatibilities with newerFCCAnalysisreleases, requiring updates across several tutorial sections.This PR aims to improve:
Notes