Enhance poscar_scale function (/data/gen.py)to detect Selective dynamics

[Mancn-Xu]

Summary

This pull request updates the poscar_scale function in the gen.py file to enhance its functionality by accurately detecting the presence of "Selective dynamics" in POSCAR files. The update ensures that the coordinate type determination is correctly handled based on whether the "Selective dynamics" line is present, improving the function's reliability and correctness in handling various POSCAR file configurations.

Changes Made

• Added a check to determine the presence of "Selective dynamics" in the POSCAR file.
• Adjusted the coordinate type line index based on the presence of "Selective dynamics" to ensure correct parsing.
• Ensured the coordinate type detection logic works accurately for both "Direct" and "Cartesian" coordinates following the presence of "Selective dynamics".
• Included clear and concise comments to improve code readability and maintenance.

Impact

This enhancement allows users to work with a wider variety of POSCAR files, especially those that include the "Selective dynamics" setting, without manually adjusting the script for different file formats. It ensures that the poscar_scale function is more adaptable and accurate, providing a robust solution for scaling atomic positions in POSCAR files.

Additional Notes

This update assumes that the "Selective dynamics" line, if present, is directly above the coordinate type line in POSCAR files, which is the standard format. Users should ensure that their POSCAR files follow this format for the script to function correctly.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 49.42%. Comparing base (042ea32) to head (0c93fe3). Report is 128 commits behind head on devel.

Files with missing lines	Patch %	Lines
dpgen/data/gen.py	50.00%	3 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #1439      +/-   ##
==========================================
+ Coverage   48.97%   49.42%   +0.44%     
==========================================
  Files          83       83              
  Lines       14792    14820      +28     
==========================================
+ Hits         7245     7325      +80     
+ Misses       7547     7495      -52     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[njzjz]

@CodiumAI-Agent /review --pr_reviewer.inline_code_comments=true

[njzjz]

@CodiumAI-Agent /improve --extend

[QodoAI-Agent]

PR Analysis

• 🎯 Main theme: Enhancing the poscar_scale function to accurately detect the presence of "Selective dynamics" in POSCAR files.
• 📝 PR summary: The PR enhances the poscar_scale function in the gen.py file to accurately detect the presence of "Selective dynamics" in POSCAR files. This update ensures that the coordinate type determination is correctly handled based on whether the "Selective dynamics" line is present, improving the function's reliability and correctness in handling various POSCAR file configurations.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the changes are straightforward and limited to a single function. However, the reviewer should be familiar with the POSCAR file format and the purpose of the "Selective dynamics" line.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are clear. It would be beneficial to add tests to ensure that the new functionality works as expected. Also, consider handling the case where the "Selective dynamics" line is not directly above the coordinate type line, even though it's not the standard format.

---

✨ Usage guide:

---

Overview: The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR. When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section The review tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.