From 60a77c8862336665586180cbc4dff47dd2e394f3 Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Sat, 27 Sep 2025 16:45:50 +0200 Subject: [PATCH 1/8] Lift basic introduction to main page --- docs/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/index.md b/docs/index.md index 3374ac3..6029363 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,10 @@ # Key4hep +Key4hep is a turnkey software stack for detector optimisation and performance studies for future collider experiments. It provides common libraries and solutions for the generation, simulation, reconstruction, and analysis of events at future colliders, with a strong focus on coherence and re-usability in order to reduce duplication of effort and foster collaboration. Key4hep serves as a common software base for future experiments, allowing project-specific adaptations to be made to accommodate their specific requirements. + +Key4hep is a community-driven project, with contributions and adaptations from different +future collider projects: CEPC, CLIC, EIC, FCC, ILC, Muon Collider. + ```{eval-rst} .. toctree:: From 6b4fa6c746df060ae643de9518c048310c67e38f Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Sat, 27 Sep 2025 16:46:01 +0200 Subject: [PATCH 2/8] Rework the landing page to not just be a TOC Lift some information out of the introduction onto the landing page. --- docs/getting_started/introduction.md | 8 +-- docs/index.md | 75 ++++++++++++++++++++++++---- 2 files changed, 66 insertions(+), 17 deletions(-) diff --git a/docs/getting_started/introduction.md b/docs/getting_started/introduction.md index 5b442ac..b6654f4 100644 --- a/docs/getting_started/introduction.md +++ b/docs/getting_started/introduction.md @@ -1,11 +1,5 @@ # Introduction -## About - -Key4hep is a turnkey software stack for detector optimisation and performance studies for future collider experiments. It provides common libraries and solutions for the generation, simulation, reconstruction, and analysis of events at future colliders, with a strong focus on coherence and re-usability in order to reduce duplication of effort and foster collaboration. Key4hep serves as a common software base for future experiments, allowing project-specific adaptations to be made to accommodate their specific requirements. - -Key4hep is a community-driven project, with contributions and adaptations from different -future collider projects: CEPC, CLIC, EIC, FCC, ILC, Muon Collider. ## Notable stack components @@ -41,4 +35,4 @@ by Key4hep are made available under the [OSI](https://opensource.org)-approved [ Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) https://ep-rnd.web.cern.ch/ European Union’s Horizon 2020 Research and Innovation programme under Grant -Agreement no. 101004761. \ No newline at end of file +Agreement no. 101004761. diff --git a/docs/index.md b/docs/index.md index 6029363..b02b5a0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,38 +1,93 @@ # Key4hep -Key4hep is a turnkey software stack for detector optimisation and performance studies for future collider experiments. It provides common libraries and solutions for the generation, simulation, reconstruction, and analysis of events at future colliders, with a strong focus on coherence and re-usability in order to reduce duplication of effort and foster collaboration. Key4hep serves as a common software base for future experiments, allowing project-specific adaptations to be made to accommodate their specific requirements. +Key4hep is a turnkey software stack for detector optimisation and performance studies for future collider experiments. It provides common libraries and solutions for the generation, simulation, reconstruction, and analysis of events at future colliders, with a strong focus on coherence and re-usability in order to reduce duplication of effort and foster collaboration. -Key4hep is a community-driven project, with contributions and adaptations from different -future collider projects: CEPC, CLIC, EIC, FCC, ILC, Muon Collider. +## Key Goals +Key4hep aims to: + +- **Unify software development** across future collider experiments by providing a common foundation +- **Reduce duplication of effort** through shared libraries and standardized interfaces +- **Enable detector optimization** with comprehensive simulation and reconstruction tools +- **Foster collaboration** between different experimental communities +- **Provide turnkey solutions** that work out-of-the-box for common physics tasks +- **Maintain coherence** across the software stack while allowing experiment-specific customizations + +## Community and Contributors + +Key4hep is a community-driven project that brings together software developers and physicists from multiple future collider experiments. The project benefits from active contributions and adaptations from: + +- **CEPC** (Circular Electron Positron Collider) +- **CLIC** (Compact Linear Collider) +- **EIC** (Electron-Ion Collider) +- **FCC** (Future Circular Collider) +- **ILC** (International Linear Collider) +- **Muon Collider** + +## Quick Start + +New to Key4hep? Start here: + +- **[Introduction](getting_started/introduction.md)** - Learn about Key4hep's goals and architecture +- **[Setup Guide](getting_started/setup.md)** - Get Key4hep running on your system +- **[Getting Help](getting_started/help.md)** - Find support and community resources + +## Main Documentation Sections + +- **[How-to Guides](how-tos/README.md)** - Step-by-step instructions for common tasks +- **[Tutorials](tutorials/README.md)** - Learn Key4hep through hands-on examples +- **[Developer Documentation](developing-key4hep-software/README.md)** - Contribute to and extend Key4hep +- **[Build Instructions](spack-build-instructions-for-librarians/README.md)** - Advanced build and deployment guides + +## Acknowledgements + +Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) https://ep-rnd.web.cern.ch/ + +European Union's Horizon 2020 Research and Innovation programme under Grant Agreement no. 101004761. ```{eval-rst} .. toctree:: :maxdepth: 2 - :caption: Getting started + :caption: Getting Started + :hidden: getting_started/introduction.md - getting_started/help.md getting_started/setup.md + getting_started/help.md getting_started/CONTRIBUTING.md - .. toctree:: :maxdepth: 3 - :includehidden: - :caption: Contents + :caption: User Guides + :titlesonly: + :hidden: how-tos/README.md tutorials/README.md + +.. toctree:: + :maxdepth: 3 + :caption: Developer Resources + :titlesonly: + :hidden: + developing-key4hep-software/README.md spack-build-instructions-for-librarians/README.md + +.. toctree:: + :maxdepth: 2 + :caption: Community + :titlesonly: + :hidden: + talks-and-presentations/README.md call-for-logos/README.md .. toctree:: :maxdepth: 2 - :includehidden: - :caption: External links + :caption: External Resources + :titlesonly: + :hidden: FCC software CLIC software From 9e4cd9abd00b15779cae7310a3c52a1dddda5417 Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Mon, 29 Sep 2025 09:16:23 +0200 Subject: [PATCH 3/8] Reword a few things to be more coherent --- docs/index.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index b02b5a0..56f8d39 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,37 +3,33 @@ Key4hep is a turnkey software stack for detector optimisation and performance studies for future collider experiments. It provides common libraries and solutions for the generation, simulation, reconstruction, and analysis of events at future colliders, with a strong focus on coherence and re-usability in order to reduce duplication of effort and foster collaboration. ## Key Goals - Key4hep aims to: - - **Unify software development** across future collider experiments by providing a common foundation - **Reduce duplication of effort** through shared libraries and standardized interfaces - **Enable detector optimization** with comprehensive simulation and reconstruction tools - **Foster collaboration** between different experimental communities - **Provide turnkey solutions** that work out-of-the-box for common physics tasks - **Maintain coherence** across the software stack while allowing experiment-specific customizations +- **Prefer reusing existing solutions** where possible and avoid re-inventing the wheel ## Community and Contributors - Key4hep is a community-driven project that brings together software developers and physicists from multiple future collider experiments. The project benefits from active contributions and adaptations from: - -- **CEPC** (Circular Electron Positron Collider) -- **CLIC** (Compact Linear Collider) -- **EIC** (Electron-Ion Collider) - **FCC** (Future Circular Collider) - **ILC** (International Linear Collider) +- **CLIC** (Compact Linear Collider) +- **CEPC** (Circular Electron Positron Collider) +- **EIC** (Electron-Ion Collider) - **Muon Collider** ## Quick Start - New to Key4hep? Start here: - - **[Introduction](getting_started/introduction.md)** - Learn about Key4hep's goals and architecture -- **[Setup Guide](getting_started/setup.md)** - Get Key4hep running on your system +- **[Getting Key4hep](getting_started/setup.md)** - Learn how and where Key4hep is available - **[Getting Help](getting_started/help.md)** - Find support and community resources -## Main Documentation Sections +Want to contribute? Look at our **[Contribution Guide](getting_started/CONTRIBUTING.md)**. +## Main Documentation Sections - **[How-to Guides](how-tos/README.md)** - Step-by-step instructions for common tasks - **[Tutorials](tutorials/README.md)** - Learn Key4hep through hands-on examples - **[Developer Documentation](developing-key4hep-software/README.md)** - Contribute to and extend Key4hep @@ -41,7 +37,7 @@ New to Key4hep? Start here: ## Acknowledgements -Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) https://ep-rnd.web.cern.ch/ +Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) [https://ep-rnd.web.cern.ch/](https://ep-rnd.web.cern.ch/) European Union's Horizon 2020 Research and Innovation programme under Grant Agreement no. 101004761. @@ -76,7 +72,7 @@ European Union's Horizon 2020 Research and Innovation programme under Grant Agre .. toctree:: :maxdepth: 2 - :caption: Community + :caption: More Information :titlesonly: :hidden: @@ -85,7 +81,7 @@ European Union's Horizon 2020 Research and Innovation programme under Grant Agre .. toctree:: :maxdepth: 2 - :caption: External Resources + :caption: Community Resources :titlesonly: :hidden: From 9b5a34cd1a4b952bd455fa3b63e27f1570319148 Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Mon, 29 Sep 2025 09:42:06 +0200 Subject: [PATCH 4/8] Add a few external links --- docs/index.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 56f8d39..2017d67 100644 --- a/docs/index.md +++ b/docs/index.md @@ -90,5 +90,14 @@ European Union's Horizon 2020 Research and Innovation programme under Grant Agre ILC software CEPC software Muon Collider software -``` +.. toctree:: + :maxdepth: 1 + :caption: External Resources + :titlesonly: + :hidden: + EDM4hep + podio + Gaudi (doxygen) + Acts +``` From 073b26abcee75019c23ab9496dc11286ef60dd0e Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Mon, 29 Sep 2025 09:43:38 +0200 Subject: [PATCH 5/8] Move licence to landing page --- docs/getting_started/introduction.md | 12 ------------ docs/index.md | 5 +++++ 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/docs/getting_started/introduction.md b/docs/getting_started/introduction.md index b6654f4..6d3695a 100644 --- a/docs/getting_started/introduction.md +++ b/docs/getting_started/introduction.md @@ -24,15 +24,3 @@ Key4hep draws significant inspiration from iLCSoft, a common software stack wide ### Infrastructure Key4hep uses the Spack package manager to manage the compilation and deployment of its packages. Spack allows experiments to share build recipes, enabling any experiment to build the stack independently or extend it for their own needs. In addition, the Key4hep stack is also built centrally and deployed to the CVMFS, from where it can be [easily accessed](setup.md). - -## License - -Except where otherwise noted, the example programs and other software provided -by Key4hep are made available under the [OSI](https://opensource.org)-approved [Apache -2.0](https://opensource.org/license/apache-2-0/). - -## Acknowledgements -Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) https://ep-rnd.web.cern.ch/ - -European Union’s Horizon 2020 Research and Innovation programme under Grant -Agreement no. 101004761. diff --git a/docs/index.md b/docs/index.md index 2017d67..160202c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,6 +35,11 @@ Want to contribute? Look at our **[Contribution Guide](getting_started/CONTRIBUT - **[Developer Documentation](developing-key4hep-software/README.md)** - Contribute to and extend Key4hep - **[Build Instructions](spack-build-instructions-for-librarians/README.md)** - Advanced build and deployment guides +## License +Except where otherwise noted, the example programs and other software provided +by Key4hep are made available under the [OSI](https://opensource.org)-approved [Apache +2.0](https://opensource.org/license/apache-2-0/). + ## Acknowledgements Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) [https://ep-rnd.web.cern.ch/](https://ep-rnd.web.cern.ch/) From 27a8e569deb063e340a8eca9d9ec1fc5adc0c4c2 Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Mon, 29 Sep 2025 09:46:24 +0200 Subject: [PATCH 6/8] Fix CERN EP R&D link --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 160202c..e443955 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,7 +42,7 @@ by Key4hep are made available under the [OSI](https://opensource.org)-approved [ ## Acknowledgements -Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)) [https://ep-rnd.web.cern.ch/](https://ep-rnd.web.cern.ch/) +Strategic R&D Programme on Technologies for Future Experiments ([CERN-OPEN-2018-006](https://cds.cern.ch/record/2649646/)). See also [the EP R&D webpage](https://ep-dep.web.cern.ch/rd-experimental-technologies). European Union's Horizon 2020 Research and Innovation programme under Grant Agreement no. 101004761. From 16c597fee3472e40dba902a3b115de8a5812e26b Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Sat, 11 Oct 2025 16:28:44 +0200 Subject: [PATCH 7/8] Fix build error --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index e443955..f74ab55 100644 --- a/docs/index.md +++ b/docs/index.md @@ -101,6 +101,7 @@ European Union's Horizon 2020 Research and Innovation programme under Grant Agre :caption: External Resources :titlesonly: :hidden: + EDM4hep podio Gaudi (doxygen) From e84471fde748a3782f8a3084c2031242b821da1c Mon Sep 17 00:00:00 2001 From: Thomas Madlener Date: Tue, 4 Nov 2025 17:34:12 +0100 Subject: [PATCH 8/8] Add link to key4hep github org --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f74ab55..0cf9abe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,7 +27,7 @@ New to Key4hep? Start here: - **[Getting Key4hep](getting_started/setup.md)** - Learn how and where Key4hep is available - **[Getting Help](getting_started/help.md)** - Find support and community resources -Want to contribute? Look at our **[Contribution Guide](getting_started/CONTRIBUTING.md)**. +Want to contribute? Look at our **[Contribution Guide](getting_started/CONTRIBUTING.md)**. The majority of Key4hep related repositories is hosted in the [key4hep github organization](https://github.com/key4hep). ## Main Documentation Sections - **[How-to Guides](how-tos/README.md)** - Step-by-step instructions for common tasks