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

arbitrary mpirun N restarts #888

Open PhilipDeegan opened 2 months ago

PhilipDeegan commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
📝 Walkthrough ## Walkthrough The changes involve significant updates across multiple files, focusing on the restructuring of the simulation initialization process, particularly for electromagnetic fields and particle handling. Several functions and classes have been removed or redefined to enhance modularity and flexibility. New modules have been introduced for managing simulation parameters, including HDF5 file interactions and initialization strategies. The updates reflect a shift towards a more organized approach to simulation configuration and data management. ## Changes | Files | Change Summary | |---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `pyphare/pyphare/pharein/__init__.py` | Removed several functions and classes related to simulation handling; modified `populateDict` to delegate to `initialize.general.populateDict(sim)`. | | `pyphare/pyphare/pharein/initialize/__init__.py` | Added imports for `general`, `user_fns`, and `samrai_hdf5`; defined `__all__` for public interface. | | `pyphare/pyphare/pharein/initialize/general.py` | Introduced functions and classes for managing simulation data, including `_patch_data_ids`, `_serialized_simulation_string`, and various utility functions for adding data types. | | `pyphare/pyphare/pharein/initialize/samrai_hdf5.py` | Added `populateDict` function for populating simulation parameters from a model. | | `pyphare/pyphare/pharein/initialize/user_fns.py` | Introduced functions for populating electromagnetic and particle properties in simulation dictionaries. | | `pyphare/pyphare/pharein/simulation.py` | Added `check_init_options` function for validating initialization options; updated `Simulation` constructor to handle new `init_options` parameter. | | `pyphare/pyphare/pharesee/hierarchy/hierarchy_utils.py` | Enhanced `EqualityReport` class; modified `__repr__` method for better error message representation. | | `pyphare/pyphare/pharesee/hierarchy/patchdata.py` | Updated constructors for `FieldData` and `ParticleData` classes to improve initialization and data handling capabilities. | | `res/cmake/test.cmake` | Removed and added subdirectories for test directories, shifting focus in test structure. | | `src/amr/data/electromag/electromag_initializer.hpp` | Introduced classes for initializing electromagnetic fields, including a factory for creating initializers based on configuration. | | `src/amr/data/field/initializers/samrai_hdf5_field_initializer.hpp` | Added `SamraiHDF5FieldInitializer` class for loading field data from HDF5 files. | | `src/amr/data/initializers/samrai_hdf5_initializer.hpp` | Established `SamraiH5Interface` for handling HDF5 file interactions and data population. | | `src/amr/data/particles/initializers/particle_initializer_factory.hpp` | Updated `ParticleInitializerFactory` to reflect new namespace and added handling for new initializers. | | `src/amr/data/particles/initializers/samrai_hdf5_particle_initializer.hpp` | Defined `SamraiHDF5ParticleInitializer` class for loading particle data from HDF5 files. | | `src/core/CMakeLists.txt` | Removed reference to `particle_initializer_factory.hpp` from compilation sources. | | `src/core/data/electromag/electromag.hpp` | Updated type aliases and removed initialization logic from constructors. | | `src/core/data/grid/gridlayout.hpp` | Modified method signatures for AMR coordinate conversions to enhance flexibility and maintain backward compatibility. | | `src/core/data/ions/ions.hpp` | Removed include directive for `particle_initializer_factory.hpp`. | | `tests/amr/data/particles/initializer/CMakeLists.txt` | Updated linked library from `phare_core` to `phare_amr`. | | `tests/amr/data/particles/initializer/test_main.cpp` | Adjusted imports and updated dictionary keys for consistency in test cases. | | `tests/amr/models/test_models.cpp` | Renamed keys in initialization dictionary for consistency. | | `tests/amr/tagging/test_tagging.cpp` | Introduced structured initialization logic using `PHAREDict` in the `SinglePatchHybridModel`. | | `tests/core/numerics/ion_updater/test_updater.cpp` | Enhanced initialization logic for electromagnetic fields and particles in tests. | | `tests/simulator/test_init_from_restart.py` | Introduced tests for restarting simulations, focusing on data comparison between outputs. | | `tools/test_data_gen.py` | Added functionality for generating test data for simulations, including functions for running simulations with specified parameters. | ## Possibly related PRs - **#879**: The changes in this PR involve modifications to the `pyphare/pyphare/pharein/__init__.py` and `pyphare/pyphare/pharein/simulation.py` files, which relate to the handling of simulation parameters and tagging thresholds. This is relevant to the main PR's restructuring of simulation initialization and handling of options, indicating a shared focus on improving the configurability and modularity of simulation processes.

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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.