Skip to content

Transition tutorial examples from Associations to Links - #12

Merged
wdconinc merged 4 commits into
mainfrom
copilot/eic-11-transition-associations-to-links
Sep 3, 2026
Merged

Transition tutorial examples from Associations to Links#12
wdconinc merged 4 commits into
mainfrom
copilot/eic-11-transition-associations-to-links

Conversation

Copilot AI commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

The tutorial and example macros were still using the legacy EICrecon association naming while the current tree layout exposes link-based branches and index arrays. This left the examples out of sync with the actual data products and their naming conventions.

  • Scope

    • Updated the lesson text, analysis snippets, and pruning utilities to use the *_Links_* branch names instead of the legacy *_Associations_* names.
    • Switched the reader arrays to TTreeReaderArray<unsigned int> and aligned the from/to index branches with the current EICrecon schema.
    • Normalized the narrative language from “association” to “link” throughout the docs and examples.
  • Examples updated

    • "_ReconstructedChargedParticleAssociations_rec.index""_ReconstructedChargedParticleLinks_from.index"
    • "_ReconstructedChargedParticleAssociations_sim.index""_ReconstructedChargedParticleLinks_to.index"
    • TTreeReaderArray<int>TTreeReaderArray<unsigned int>
 // Get Links Between MCParticles and ReconstructedChargedParticles
 TTreeReaderArray<unsigned int> recoAssoc(tree_reader, "_ReconstructedChargedParticleLinks_from.index");
 TTreeReaderArray<unsigned int> simuAssoc(tree_reader, "_ReconstructedChargedParticleLinks_to.index");
  • Notes

    • The migration was applied consistently across the tutorial, exercise scripts, and pruning examples rather than only to the highlighted instance.
    • A few copy-paste typos and a stray Python syntax issue in the exercise script were corrected in the same pass to keep the examples usable as written.

Copilot AI linked an issue Aug 30, 2026 that may be closed by this pull request
Co-authored-by: wdconinc <4656391+wdconinc@users.noreply.github.com>
Copilot AI changed the title [WIP] Transition from associations to links in analysis Transition tutorial examples from Associations to Links Aug 30, 2026
Copilot AI requested a review from wdconinc August 30, 2026 16:05
@github-actions

github-actions Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/eic/tutorial-analysis/compare/md-outputs..md-outputs-PR-12

The following changes were observed in the rendered markdown documents:

 03-analysis.md         |  66 ++++++++++++------------
 branch-dictionary.md   |   8 +--
 exercise-scripts.md    | 136 ++++++++++++++++++++++++-------------------------
 files/TreePrune.C      |   4 +-
 md5sum.txt             |   8 +--
 tree-pruning-script.md |   4 +-
 6 files changed, 113 insertions(+), 113 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-08-30 16:20:39 +0000

@wdconinc
wdconinc marked this pull request as ready for review August 30, 2026 16:12
Copilot AI lite review requested due to automatic review settings August 30, 2026 16:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the tutorial documentation and example macros to align with the current EICrecon output schema by replacing legacy *_Associations_* usage with *_Links_* branches and updating related narrative text.

Changes:

  • Updated pruning examples to keep link-related branches instead of association branches.
  • Updated C++ (TTreeReader) and Python examples to use _ReconstructedChargedParticleLinks_{from,to}.index and TTreeReaderArray<unsigned int>.
  • Reworded tutorial text from “association” to “link” across the lesson and learner docs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
learners/tree-pruning-script.md Updates the pruning script snippet to retain *Links* branches.
learners/files/TreePrune.C Updates the actual ROOT pruning macro to keep link branches (needs a small pattern fix).
learners/exercise-scripts.md Migrates multiple exercise code templates (C++/Python/RDF) from associations to links.
learners/branch-dictionary.md Renames branch sections and updates explanatory text to “links” (needs a wording correction).
episodes/03-analysis.md Updates Episode 3 tutorial narrative and code blocks to use link-based branches and unsigned indices.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread learners/files/TreePrune.C Outdated
Comment thread learners/branch-dictionary.md Outdated
wdconinc and others added 2 commits August 30, 2026 11:18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@wdconinc
wdconinc requested review from aprozo and sjdkay August 30, 2026 16:20

@wdconinc wdconinc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

@sjdkay sjdkay left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, even a typo fix to boot.

@wdconinc
wdconinc merged commit 5b3627b into main Sep 3, 2026
5 checks passed
github-actions Bot pushed a commit that referenced this pull request Sep 3, 2026
Auto-generated via `{sandpaper}`
Source  : 5b3627b
Branch  : main
Author  : Wouter Deconinck <wdconinc@gmail.com>
Time    : 2026-09-03 15:01:54 +0000
Message : Merge pull request #12 from eic/copilot/eic-11-transition-associations-to-links

Transition tutorial examples from Associations to Links
github-actions Bot pushed a commit that referenced this pull request Sep 3, 2026
Auto-generated via `{sandpaper}`
Source  : d994466
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-09-03 15:04:14 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5b3627b
Branch  : main
Author  : Wouter Deconinck <wdconinc@gmail.com>
Time    : 2026-09-03 15:01:54 +0000
Message : Merge pull request #12 from eic/copilot/eic-11-transition-associations-to-links

Transition tutorial examples from Associations to Links
github-actions Bot pushed a commit that referenced this pull request Sep 8, 2026
Auto-generated via `{sandpaper}`
Source  : d994466
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-09-03 15:04:14 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5b3627b
Branch  : main
Author  : Wouter Deconinck <wdconinc@gmail.com>
Time    : 2026-09-03 15:01:54 +0000
Message : Merge pull request #12 from eic/copilot/eic-11-transition-associations-to-links

Transition tutorial examples from Associations to Links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Transition from Associations to Links

4 participants