search

FairRootGroup / FairRoot

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

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

Closed karabowi closed 2 months ago

karabowi commented 4 months 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 4 months 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 state management has been refined with the addition of new states and modifications to existing methods like `AddIons()` and `InitGeometry()`. Additionally, new methods for folder management have been added to the `FairRootManager` class to facilitate dynamic folder removal from the ROOT directory. ## Changes | File Path | Change Summary | |-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | `fairroot/base/sim/FairMCApplication.cxx` | Restructured initialization; added `InitFinalizer()`, updated state transitions in `InitMC`, `RunMC`, and `InitGeometry`, modified `AddIons()` | | `fairroot/base/sim/FairMCApplication.h` | Updated state enum, added `InitFinalizer()` method, streamlined comments, introduced `fIonsAreAdded` variable | | `fairroot/base/steer/FairRootManager.cxx` | Added `RemoveFolder()` and `RemoveOutputFolderForMtMode()` methods for dynamic folder removal | | `fairroot/base/steer/FairRootManager.h` | Added declarations for `RemoveFolder()` and `RemoveOutputFolderForMtMode()` methods; reorganized include statements | | `fairroot/base/steer/FairRunSim.h` | Added documentation comment for `SetMCConfig()` method to clarify its responsibilities | | `examples/simulation/rutherford/macros/CMakeLists.txt` | Modified command for running `run_rutherford.sh` to include an additional boolean argument | ## Possibly related PRs - #1574: The changes in `FairMCApplication.cxx` within this PR involve modifications to the `FairMCApplication` class, which is directly related to the changes made in the main PR regarding state management and method alterations in the same file. - #1577: This PR involves removing unneeded references to `FairRootManager`, which is relevant as the main PR also modifies the `FairMCApplication` class and its interaction with the `FairRootManager`, indicating a connection in the context of managing application states and resources.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between d84e17f40c4559515ae8420f8652230107902115 and 63b6d7f02d889cfc79f3d3f8cc5d601fbed85207.
Files selected for processing (7) * examples/simulation/rutherford/macros/CMakeLists.txt (1 hunks) * fairroot/base/sim/FairMCApplication.cxx (7 hunks) * fairroot/base/sim/FairMCApplication.h (6 hunks) * fairroot/base/sink/FairRootFileSink.cxx (0 hunks) * fairroot/base/steer/FairRootManager.cxx (3 hunks) * fairroot/base/steer/FairRootManager.h (2 hunks) * fairroot/base/steer/FairRunSim.h (1 hunks)
Files not reviewed due to no reviewable changes (1) * fairroot/base/sink/FairRootFileSink.cxx
Files skipped from review as they are similar to previous changes (6) * examples/simulation/rutherford/macros/CMakeLists.txt * fairroot/base/sim/FairMCApplication.cxx * fairroot/base/sim/FairMCApplication.h * fairroot/base/steer/FairRootManager.cxx * fairroot/base/steer/FairRootManager.h * fairroot/base/steer/FairRunSim.h
--- 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 , 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 generate interesting stats about this repository and render them as a table.` -- `@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 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` or `@coderabbitai title` 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](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 4 months 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 4 months 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 4 months 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 4 months ago

@karabowi reopned this

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

ChristianTackeGSI commented 4 months 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 4 months 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 4 months ago

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

Can we document exactly this somewhere, please?

Maybe on FairRunSim and/or FairMCApplication?

Done.

ChristianTackeGSI commented 2 months ago

Hi @karabowi,

https://github.com/FairRootGroup/FairRoot/blob/6decd1eeb31aba0aa2c196e19b4acafe6f76e854/fairroot/base/sink/FairRootFileSink.cxx#L249-L250

do you want to remove this? Or keep it for backward compatibility?

karabowi commented 2 months ago

Hi @karabowi,

https://github.com/FairRootGroup/FairRoot/blob/6decd1eeb31aba0aa2c196e19b4acafe6f76e854/fairroot/base/sink/FairRootFileSink.cxx#L249-L250

do you want to remove this? Or keep it for backward compatibility?

I have removed this line, or rather moved it to FairMCApplication::InitFinalizer().