search

PHAREHUB / PHARE

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

Expose env var handling to python #856

Open PhilipDeegan opened 3 months ago

PhilipDeegan commented 3 months ago

For https://github.com/PHAREHUB/PHARE/issues/831

To allow python to know about env vars from C++

suggestive as is

> python3 -c "from pyphare import cpp; cpp.print_env_vars_info()"
PHARE_SCOPE_TIMING: Enable function scope timing
Options:
  1: ON
  0: OFF

PHARE_LOG: Write logs to $CWD/.log
Options:
  RANK_FILES: Write logs $CWD/.log, a file per rank
  DATETIME_FILES: Write logs $CWD/.log, filename per rank and datetime
  NONE: print normally to std::cout

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The updates introduce a centralized handling system for environment variables in the `PHARE` namespace, including the implementation of `Var` and `Env` classes. This enhancement enables more efficient management and access to environment variables across the codebase. Additionally, new utility functions for string conversion and MPI initialization are introduced, along with corresponding tests and Python bindings for interacting with these features. ## Changes | Files / Directories | Change Summary | |--------------------------------------------------------|--------------------------------------------------------------------------------------------------| | `res/cmake/test.cmake` | Added a new subdirectory `env` under `core/utilities` in the CMake configuration for testing. | | `src/core/env.hpp` | Introduced a new environment variable handling system with `Var` struct and `Env` class. | | `src/core/utilities/mpi_utils.cpp`, `mpi_utils.hpp` | Added `bool any(bool b)` function and `Lifecycle` struct for managing MPI initialization. | | `src/core/utilities/types.hpp` | Introduced template functions `from_string` and `get_env_as` for type conversion and retrieval. | | `src/hdf5/detail/h5/h5_file.hpp` | Simplified `file()` function and refactored `write_attribute` function for better readability. | | `src/phare/phare.hpp` | Updated to utilize the new `Env` class for environment variable access in logging functionality. | | `src/python3/cpp_etc.cpp` | Added new functions and bindings for environmental variables in the `Env` class. | | `src/simulator/simulator.hpp` | Modified logging initialization to use `Env::INSTANCE().PHARE_LOG`. | | `tests/core/utilities/env/CMakeLists.txt` | Created a CMake project for testing the `phare-env` module. | | `tests/core/utilities/env/test_env.cpp` | Established tests for the logging functionality within the `Env` class. | | `tests/core/utilities/test_mpi_utils.hpp` | Introduced `Lifecycle` struct for managing MPI initialization and finalization. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Env participant Var User->>Env: Access INSTANCE() Env-->>User: Return singleton instance User->>Env: Call PHARE_LOG("PHARE_LOG_FILE") Env->>Var: Fetch PHARE_LOG variable Var-->>Env: Return PHARE_LOG value Env-->>User: Return PHARE_LOG value User->>Env: Call PHARE_SCOPE_TIMING() Env->>Var: Fetch PHARE_SCOPE_TIMING variable Var-->>Env: Return PHARE_SCOPE_TIMING value Env-->>User: Return PHARE_SCOPE_TIMING value ```

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.