search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
57 stars 96 forks source link

feat(sim): Allow branch registration in `FairGenerator` #1575

Open karabowi opened 1 month ago

karabowi commented 1 month ago

Introduced new function FairMCApplication::InitFinalizer() which initializes event generator, tasks, and triggers FairRootManager::WriteFolder() function. This new function is called from the latter of InitGeometry() and AddIons().

Previously the funcionality of InitFinalizer was split between InitGeometry() and AddIons(), which caused problems because TGeant3 calls AddIons() first, InitGeometry() second, TGeant4 calls InitGeometry() first, AddIons() second.

Current implementation assures that initialization of event generators and tasks come before WriteFolder.

Fixes issues #1183 and #1567.

Checklist:

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The changes enhance the initialization workflow of the `FairMCApplication` class within Fairroot by introducing the `InitFinalizer()` method, which consolidates event generator and task initialization. The `AddIons()` and `InitGeometry()` methods have been refined for improved state management. Additionally, a new `SetMCConfig()` method has been added in `FairRunSim` to streamline simulation setup. Finally, the `CMakeLists.txt` for the Rutherford example has been updated to modify test execution behavior. ## Changes | File Path | Change Summary | |-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | `fairroot/base/sim/FairMCApplication.cxx` | Restructured initialization; added `InitFinalizer()`, updated state transitions in `InitMC`, `RunMC`, and `ConstructGeometry`, modified `AddIons()` | | `fairroot/base/sim/FairMCApplication.h` | Updated state enum, added `InitFinalizer()` method, streamlined comments, introduced `fIonsAreAdded` variable | | `fairroot/base/steer/FairRunSim.h` | Added `SetMCConfig()` method for simulation initialization | | `examples/simulation/rutherford/macros/CMakeLists.txt` | Updated `run_rutherford.sh` command in `add_test` to include additional argument | ## Sequence Diagram(s) ### New Initialization Flow in FairMCApplication ```mermaid sequenceDiagram participant User participant FairMCApplication participant RootManager User ->> FairMCApplication: AddIons() FairMCApplication ->> FairMCApplication: fIonsAreAdded = true FairMCApplication ->> FairMCApplication: Check fIonsAreAdded && fGeometryIsInitialized FairMCApplication ->> FairMCApplication: InitFinalizer() FairMCApplication ->> RootManager: WriteFolder() User ->> FairMCApplication: InitGeometry() FairMCApplication ->> FairMCApplication: Check GetIsMT() FairMCApplication ->> RootManager: WriteFolder() FairMCApplication ->> FairMCApplication: Check fIonsAreAdded && fGeometryIsInitialized FairMCApplication ->> FairMCApplication: InitFinalizer() ``` ### SetMCConfig Flow in FairRunSim ```mermaid sequenceDiagram participant User participant FairRunSim participant FairMCApplication User ->> FairRunSim: SetMCConfig() FairRunSim ->> FairMCApplication: Initialize MC Application FairRunSim ->> FairRunSim: Set simulation configuration FairRunSim ->> FairRunSim: Post-initialization configurations ```
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 8023a59192722017f0b948e32b46bcbf2dd3724a and b4a2bfc4279565d72650343d4e4fd6a33d83d1cc.
Files selected for processing (4) * examples/simulation/rutherford/macros/CMakeLists.txt (1 hunks) * fairroot/base/sim/FairMCApplication.cxx (12 hunks) * fairroot/base/sim/FairMCApplication.h (6 hunks) * fairroot/base/steer/FairRunSim.h (1 hunks)
Files skipped from review due to trivial changes (1) * fairroot/base/steer/FairRunSim.h
Additional comments not posted (6)
examples/simulation/rutherford/macros/CMakeLists.txt (1)
`16-16`: **Verify handling of the new boolean parameter in the test script.** Ensure that the `run_rutherford.sh` script correctly interprets and utilizes the new boolean parameter (`false`) added to the test command.
fairroot/base/sim/FairMCApplication.h (3)
`49-54`: **Approve updates to the `FairMCApplicationState` enum.** The addition of new states (`kPreInit`, `kConstructGeometry`, `kInit`, `kInitGeometry`, `kPostInit`, `kRun`) enhances the clarity and management of application states, aligning with the enhanced initialization logic. --- `329-329`: **Approve the initialization of `fState` with `kPreInit`.** Initializing `fState` with `kPreInit` ensures that the application starts in a defined state, which is crucial for predictable behavior and proper state management. --- `245-249`: **Approve the addition of the `InitFinalizer()` method.** The `InitFinalizer()` method centralizes the initialization of the event generator, tasks, and output folder writing, which enhances the modularity and clarity of the initialization process.
fairroot/base/sim/FairMCApplication.cxx (2)
`283-285`: **Approve the introduction and usage of `InitFinalizer()`.** The `InitFinalizer()` method is correctly introduced and used in both `InitMC` and `InitOnWorker`, ensuring consistent and centralized initialization of essential components. Also applies to: 473-474 --- `283-285`: **Approve the changes related to the management of `fState`.** The changes ensure explicit and appropriate state transitions (`kPostInit`, `kRun`, `kInit`), enhancing the clarity and robustness of state management within the application. Also applies to: 292-293, 823-923
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
dennisklein commented 1 month ago

Could you please add some documentation of the FairMCApplication state machine? At least on the initialization part? After the FairMCApplication is constructed, e.g. which of the various Init* member functions are supposed to be called in which order to complete a successful initialization? Just for internal code documentation. Thx!

karabowi commented 1 month ago

Could you please add some documentation of the FairMCApplication state machine? At least on the initialization part? After the FairMCApplication is constructed, e.g. which of the various Init* member functions are supposed to be called in which order to complete a successful initialization? Just for internal code documentation. Thx!

It is too hot to work;).

I wish it was that easy. Lets consider three FairMCApplication's functions: ConstructGeometry, InitGeometry and AddIons. They are all called internally from TGeant3 or TGeant4.

FairRunSim runs the simulation initialization in SetMCConfig() function, which:

What do you think about such a state order: kPreInit -> kConstructGeometry -> kInit -> kInitGeometry -> kPostInit -> kRun? I will implement that and lets see.

dennisklein commented 1 month ago

What do you think about such a state order: kPreInit -> kConstructGeometry -> kInit -> kInitGeometry -> kPostInit -> kRun? I will implement that and lets see.

What do you mean by that? Implement what?

ChristianTackeGSI commented 1 month ago

@karabowi reopned this

If you wanted to rerun the CI due to the errors:

ChristianTackeGSI commented 1 month ago

FairRunSim runs the simulation initialization in SetMCConfig() function, which: …

Can we document exactly this somewhere, please?

Maybe on FairRunSim and/or FairMCApplication?

dennisklein commented 1 month ago

What do you think about such a state order: kPreInit -> kConstructGeometry -> kInit -> kInitGeometry -> kPostInit -> kRun? I will implement that and lets see.

What do you mean by that? Implement what?

Now I see the confusion, sry, I was not referring to the fState member variable. I was just using the term "state machine" loosely to refer to the multi-phase initialization design of the FairMCApplication class. What I am looking for is some documentation on each of then Init*-type functions. Basically, what are their pre- and post-conditions.

I now also see that this design is partly coming from VMC and FairRoot attached all kinds of additional state to this class. I give up, nevermind my request for documentation.

karabowi commented 1 month ago

FairRunSim runs the simulation initialization in SetMCConfig() function, which: …

Can we document exactly this somewhere, please?

Maybe on FairRunSim and/or FairMCApplication?

Done.