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

fix: Fix material decorator wiring in Python Examples #4110

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

pbalek
Copy link
Contributor

@pbalek pbalek commented Feb 25, 2025

Fix naming of material decorator for ITk example. Now, materialDecorator is used for TGeoDetector. Variable mdecorator exists only in getOpenDataDetector() function, not used by ITk.

Summary by CodeRabbit

  • New Features
    • Expanded detector configuration options for enhanced setup flexibility.
  • Refactor
    • Updated configuration parameter naming for improved clarity and consistency without altering functionality.

Copy link

coderabbitai bot commented Feb 25, 2025

Walkthrough

Updated, the changes have been. In multiple example modules, the parameter once known as mdecorator is renamed to materialDecorator in function calls such as buildITkGeometry and in the instantiation of GenericDetector. Additionally, a new member named materialDecorator is introduced in the TGeoDetector::Config structure within the C++ code to be exposed to Python, yes. Functionality remains unchanged, merely clarity and consistency, these modifications bring.

Changes

File(s) Change Summary
Examples/.../itk.py, Examples/.../propagation.py Renamed parameter mdecorator to materialDecorator in function calls for clarity and consistency.
Examples/.../Detector.cpp Added new member materialDecorator to TGeoDetector::Config, exposed to Python via the ACTS_PYTHON_MEMBER macro.

Possibly related PRs

Suggested labels

Component - Examples, Component - Plugins, automerge

Suggested reviewers

  • andiwand

Poem

Changed, the code has been, so clear and true,
Renamed our parameters, as the light shines through.
A new member joins the force in our config array,
Consistency and clarity lead the way.
May the code be with you, always, mmm, yes!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d15f9a3 and 9eed6ca.

📒 Files selected for processing (3)
  • Examples/Python/python/acts/examples/itk.py (2 hunks)
  • Examples/Python/src/Detector.cpp (1 hunks)
  • Examples/Scripts/Python/propagation.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • Examples/Python/python/acts/examples/itk.py
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • 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: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / clang_tidy
🔇 Additional comments (2)
Examples/Scripts/Python/propagation.py (1)

75-75: Correctly renamed parameter, you have.

From mdecorator to materialDecorator, the parameter name changed is. Consistency with other parts of the codebase, this brings. Clear and descriptive naming convention, it follows now.

Examples/Python/src/Detector.cpp (1)

222-222: Good addition to the TGeoDetector::Config structure, this is.

The member materialDecorator added to Python interface has been. Consistent with naming changes in other files, this is. Clarity and proper naming convention for the ITk example, brings this does.

✨ 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.

@github-actions github-actions bot added this to the next milestone Feb 25, 2025
@github-actions github-actions bot added the Component - Examples Affects the Examples module label Feb 25, 2025
@andiwand andiwand changed the title fix: material decorator fix: Fix material decorator wiring in Python Examples Feb 25, 2025
Copy link

github-actions bot commented Feb 25, 2025

📊: Physics performance monitoring for 1408143

Full contents

physmon summary

@kodiakhq kodiakhq bot merged commit 5c7de7a into acts-project:main Feb 27, 2025
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants