Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: detray material collection #4065

Merged

Conversation

asalzburger
Copy link
Contributor

@asalzburger asalzburger commented Jan 31, 2025

This PR adds the possibility to record material from detray.

Currently, the material_tracer does not return enough information to fill the individual steps sense fully, this can come at a later stage.

itk_gen2_v_eta_vs_t_X0

--- END COMMIT MESSAGE ---

@beomki-yeo - the material maps for the ITk look actually quite good, it seems!

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced material tracking during particle propagation
    • Improved material information capture in detector simulation
  • Bug Fixes

    • Adjusted error handling for material conversion scenarios
    • Removed strict runtime error for unsupported binning configurations
  • Refactor

    • Updated propagation and material conversion methods to support more flexible material tracking

Copy link

coderabbitai bot commented Jan 31, 2025

Walkthrough

In the realm of particle physics code, two significant modifications have emerged. The DetrayPropagator.hpp file introduces a MaterialTracer to enhance propagation with material tracking capabilities. Meanwhile, in DetrayMaterialConverter.cpp, error handling for surface material conversion has been simplified by removing a runtime error throw, potentially allowing more flexible processing of binning configurations.

Changes

File Change Summary
Examples/Algorithms/Traccc/.../DetrayPropagator.hpp - Added MaterialTracer type
- Updated Propagator to include material tracing
- Introduced materialTracerState for material information tracking
Plugins/Detray/src/DetrayMaterialConverter.cpp - Removed runtime error for unsupported binning
- Modified method signature to accept additional parameters

Sequence Diagram

sequenceDiagram
    participant Propagator
    participant MaterialTracer
    participant DetrayStore
    
    Propagator->>DetrayStore: Initialize memory resource
    Propagator->>MaterialTracer: Create tracer state
    MaterialTracer-->>Propagator: Track material properties
    Propagator->>Propagator: Record material information (sX0, sL0)
Loading

Poem

Propagation's mystic dance unfolds,
Material traces, secrets untold
Code weaves through quantum's embrace 🌟
Trackers leap with silicon grace
Physics whispers, algorithms sing! 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@asalzburger asalzburger added this to the next milestone Jan 31, 2025
@github-actions github-actions bot added Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins labels Jan 31, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
Examples/Algorithms/Traccc/include/ActsExamples/Traccc/DetrayPropagator.hpp (3)

109-111: Extended actor chain, a subtle approach this is.
Performance overhead in mind, keep you must. Measure changes carefully as the code matures, yes.


118-121: MaterialTracer state initialization, wise it seems.
Null memory resource, handle gracefully you should, if ever needed. Offer assistance, I can.


146-151: Material retrieval, a good first step it is.
Further data logged, consider you might. Broad coverage in tests, ensure.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 19e22e8 and 9825406.

📒 Files selected for processing (2)
  • Examples/Algorithms/Traccc/include/ActsExamples/Traccc/DetrayPropagator.hpp (3 hunks)
  • Plugins/Detray/src/DetrayMaterialConverter.cpp (0 hunks)
💤 Files with no reviewable changes (1)
  • Plugins/Detray/src/DetrayMaterialConverter.cpp
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: CI Bridge / lcg_106a: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc14]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
  • GitHub Check: CI Bridge / linux_ubuntu_2204_clang
  • GitHub Check: CI Bridge / linux_ubuntu_2204
  • GitHub Check: CI Bridge / build_linux_ubuntu
  • GitHub Check: missing_includes
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
  • GitHub Check: linux_ubuntu
  • GitHub Check: build_debug
  • GitHub Check: CI Bridge / build_gnn_tensorrt
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: CI Bridge / build_exatrkx_cpu
🔇 Additional comments (3)
Examples/Algorithms/Traccc/include/ActsExamples/Traccc/DetrayPropagator.hpp (3)

23-23: New include, well-chosen it is.
Include for material validation utilities, strongly aligned with the tracer approach, hmm.


105-107: Freshly defined MaterialTracer, impressed I am.
Ensure your double precision and vecmem usage meet performance demands, you should.


123-123: Propagation with actor states, verify concurrency paths, you must.
If multi-threaded scenarios arise, mind potential thread-safety of your actors, you should.

Copy link

📊: Physics performance monitoring for 9825406

Full contents

physmon summary

@kodiakhq kodiakhq bot merged commit b9c3ae1 into acts-project:main Jan 31, 2025
48 checks passed
@acts-project-service
Copy link
Collaborator

🔴 Athena integration test results [b9c3ae1]

Build job with this PR failed!

Please investigate the build job for the pipeline!

@acts-project-service acts-project-service added the Breaks Athena build This PR breaks the Athena build label Jan 31, 2025
@paulgessinger paulgessinger modified the milestones: next, v39.1.0 Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaks Athena build This PR breaks the Athena build Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants