PHAREHUB / PHARE

💫 Parallel Hybrid Particle In Cell code with Adaptive mesh REfinement
https://phare.readthedocs.io
GNU General Public License v3.0
71 stars 24 forks source link

Charge #891

Closed nicolasaunai closed 1 month ago

nicolasaunai commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The changes introduced in this pull request involve comprehensive renaming and restructuring of variables related to ion and proton densities and momentum tensors in the `ElectronsTest` class within `test_electrons.cpp`. Additionally, modifications were made to the `plot_2d_patches` method in `hierarchy.py` to enhance visualization, and several updates were applied to `test_advance.py` to improve the accuracy and robustness of fluid diagnostics tests. These changes collectively enhance code clarity, maintainability, and testing functionality without altering the core logic. ## Changes | Files | Change Summary | |-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| | `tests/core/data/electrons/test_electrons.cpp` | Renamed variables related to ion and proton densities for clarity; updated function signatures and access methods accordingly. | | `pyphare/pyphare/pharesee/hierarchy/hierarchy.py` | Enhanced `plot_2d_patches` method for better visualization; increased subplot size and improved rendering logic. | | `tests/simulator/test_advance.py` | Renamed diagnostic quantities for accuracy; adjusted file references and assertion tolerances; improved error handling and visualization on assertion failures. | ## Possibly related PRs - **#862**: The changes in this PR involve modifications to assertions and debugging options, which may relate to the testing framework used in the main PR's `test_electrons.cpp`, particularly in how tests are structured and validated. - **#866**: This PR focuses on the removal of the `compute_timestamps` parameter, which aligns with the changes in variable naming and management in the main PR, suggesting a potential connection in how diagnostics are handled. - **#867**: The modifications in this PR include changes to the testing logic in `test_advance.py`, which also involves density-related variables, similar to the renaming and restructuring of variables in the main PR. - **#872**: This PR introduces new parameters for simulation configuration, which may relate to the overall structure and management of simulation data in the main PR's context. - **#879**: The introduction of tagging thresholds in this PR could relate to the management of simulation parameters, which is a theme present in the main PR's changes to variable names and structures. - **#883**: The changes in this PR regarding file access modes and simplifications in data handling may connect to the overall improvements in clarity and maintainability seen in the main PR's modifications.

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 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 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. ### 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.
nicolasaunai commented 1 month ago

closing for @rochSmets to make a new PR with his last edits