Add a CAD simulation tutorial section, generated from its sources in AliceO2 - #59
Merged
Merged
Conversation
This adds a new documentation section, CAD simulation tutorial, and the job that keeps it in step with its sources. - docs/cadtutorial holds the section. It is generated, not edited here. - The sources live in AliceO2, Detectors/CADSupport/doc/tutorial, next to the converter they document. - .github/scripts/sync_cad_tutorial.py converts them: GitHub alerts become the theme's note and warning fences, and each page gets its front matter. - .github/workflows/cad-tutorial-sync.yml runs it weekly and on demand, and commits when the result changes. AliceO2Group/AliceO2#15790 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017gNpas1pZ9DNBhVesoM5QZ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a documentation section, CAD simulation tutorial, covering the route from a CAD model to hits in
o2-sim, together with the job that keeps it in step with the code it documents. The section is published atdocs/cadtutorialand appears in the contents as the last entry.The pages are not maintained here. They are written and reviewed in AliceO2, under
Detectors/CADSupport/doc/tutorial, beside the converter, and converted into this site's conventions by a script in this repository. Documentation that lives away from its implementation drifts from it; generating the section removes that failure mode without moving the tutorial out of the code review that keeps it correct.The section
Fourteen pages: installing the converter, a first conversion of the shipped example model, how each solid is represented and how faithfully, selecting part of a model, materials, the magnetic field and physics cuts, the generated ROOT macro, adding the result to
o2-simas passive material and then as a sensitive detector, growing a study into a real detector class, a worked example that takes the ITS out to STEP and back and simulates hits in the result, and two reference pages on checking a conversion and on the known limits.The conversion
.github/scripts/sync_cad_tutorial.pyperforms two transformations and copies the figures:> [!NOTE]) become fencednoteandwarningblocks, which_layouts/tasks/shortcodes.liquidrenders as callouts. The bold line under the alert marker is kept as the callout's own heading, because the theme's title is fixed. A code fence inside an alert cannot be carried into a fenced callout, so the script stops rather than emit a broken page.sortandtitlefront matter the navigation is built from. The section sorts after the existing ones.Mermaid diagrams, tables, images and relative links pass through unchanged; the theme already renders ```mermaid fences.
.github/workflows/cad-tutorial-sync.ymlruns the script weekly and onworkflow_dispatch, and commitsdocs/cadtutorialwhen the output changes.Merge order
The sources are added to AliceO2 by AliceO2Group/AliceO2#15790, which is open against
dev. The generated pages in this PR are complete and self-contained, so the section is correct as it stands, but the sync job fetches fromdevand will fail until that PR merges. This PR should therefore follow it.The generated pages were checked against
.markdownlint.jsonand the front matter and shortcode syntax against the theme's own layouts; they have not been rendered locally, as the Jekyll preview needs a container.Overall, the site gains a complete tutorial for CAD-derived simulation geometry, and gains it in a form that cannot fall out of step with the converter.
🤖 Generated with Claude Code
https://claude.ai/code/session_017gNpas1pZ9DNBhVesoM5QZ