FairRoot icon indicating copy to clipboard operation
FairRoot copied to clipboard

Introduce FairExampleRunSim

Open ChristianTackeGSI opened this issue 11 months ago • 1 comments


Checklist:

ChristianTackeGSI avatar Jul 20 '23 21:07 ChristianTackeGSI

Walkthrough

Walkthrough

The recent updates encompass a range of modifications aimed at enhancing functionality and code readability across several files. Key changes include the introduction of the FairExampleRunSim class, replacing FairRunSim in various instances, and the addition of new header files. These adjustments facilitate the use of a custom class for simulation runs, improving the initialization process and streamlining code structure. Additionally, copyright years have been updated, and unnecessary method calls have been removed, further refining the codebase.

Changes

File(s) Change Summary
examples/MQ/pixelDetector/macros/run_sim.C
examples/advanced/Tutorial3/macro/run_sim.C
examples/advanced/Tutorial3/macro/run_sim_sep.C
examples/advanced/propagator/macros/runMC.C
examples/advanced/propagator/macros/runMM.C
Updated copyright year, added new header file inclusions, replaced FairRunSim with FairExampleRunSim including additional parameters during initialization, and improved code readability with using directives for cout and endl.
examples/MQ/pixelDetector/src/devices/FairMQSimDevice.cxx
examples/MQ/pixelSimSplit/src/devices/FairMQTransportDevice.cxx
Introduced FairExampleRunSim.h inclusion, updated fRunSim initialization to use FairExampleRunSim constructor with specific parameters, and removed SetName method calls. Adjusted comments and conditional checks.
examples/common/mcstack/CMakeLists.txt Added FairExampleRunSim.cxx to the project source files.
examples/common/mcstack/FairExampleRunSim.cxx
examples/common/mcstack/FairExampleRunSim.h
Introduced the FairExampleRunSim class, inheriting from FairRunSim with a constructor accepting mcEngine as a parameter, tailored for complex experiments.
examples/common/mcstack/LinkDef.h Updated copyright year and added a new C++ class declaration FairExampleRunSim.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Feb 23 '24 15:02 coderabbitai[bot]