search

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

rm cli arg parsing #846

Closed PhilipDeegan closed 5 months ago

PhilipDeegan commented 5 months ago

more trouble than it's worth I think

we might consider some wrapper instead, which we can more guarantee no conflicts with

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!WARNING]

.coderabbit.yaml is using a deprecated configuration schema

The configuration schema (version 1) is deprecated and will be removed soon. Please migrate to the latest schema version.

New Configuration YAML ```yaml early_access: false enable_free_tier: true language: en tone_instructions: '' knowledge_base: learnings: scope: auto issues: scope: auto jira: project_keys: [] linear: team_keys: [] chat: auto_reply: true reviews: profile: chill request_changes_workflow: false high_level_summary: true high_level_summary_placeholder: '@coderabbitai summary' poem: false review_status: true collapse_walkthrough: true path_filters: [] path_instructions: - path: '**.hpp' instructions: >- Review the C++ code, point out issues relative to principles of clean code, expressiveness, and performance. tools: shellcheck: enabled: true ruff: enabled: true markdownlint: enabled: true github-checks: enabled: true timeout_ms: 90000 languagetool: enabled: true disabled_rules: - EN_UNPAIRED_BRACKETS disabled_categories: - TYPOS - TYPOGRAPHY - CASING enabled_only: false level: default biome: enabled: true hadolint: enabled: true auto_review: enabled: true auto_incremental_review: true ignore_title_keywords: - WIP labels: [] drafts: true base_branches: - master ```
Configuration Instructions - 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`
Walkthrough ## Walkthrough The main changes involve refactoring how simulation settings are configured and validated. The `simulation.py` now adjusts `dry_run` and `write_reports` settings based on environment variables. In `simulator.py`, the code has been updated to use `self.simulation` instead of `CLI_ARGS` for controlling simulation behavior. Additionally, the `def.cmake` file has been modified to change the environment setting for tests from `PHARE_SKIP_CLI=1` to `PHARE_TESTING=1`. ## Changes | File | Change Summary | |-------------------------------------|----------------------------------------------------------------------------------------------------| | `pyphare/.../simulation.py` | Removed `CLI_ARGS` and adjusted `dry_run` and `write_reports` settings based on environment variables. | | `pyphare/.../simulator.py` | Replaced `CLI_ARGS` with `self.simulation` for simulation control and added validation checks. | | `res/cmake/def.cmake` | Updated environment setting from `PHARE_SKIP_CLI=1` to `PHARE_TESTING=1` in test configuration. | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant User participant Environment participant Simulation participant Simulator User->>Environment: Set environment variables (dry_run, write_reports) User->>Simulation: Initialize with environment variables Simulation->>Simulator: Pass settings (dry_run, write_reports) Simulator->>Simulator: Validate settings Simulator->>Simulation: Execute simulation based on settings Simulation->>User: Return results ```

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.` 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 full the 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 help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.