Skip to content

Feat/enhance post fp cp2k #1786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

SchrodingersCattt
Copy link
Contributor

@SchrodingersCattt SchrodingersCattt commented Aug 1, 2025

Summary by CodeRabbit

  • New Features

    • Automatic determination of spin multiplicity in CP2K input files based on chemical composition and system charge.
  • Bug Fixes

    • Improved mapping of pseudopotential and orbital files to atomic types for better alignment in input generation.
    • Enhanced robustness in reading model deviation files and prevented empty systems from being counted as successful in post-processing.
  • Chores

    • Updated Python linter version in pre-commit configuration.
    • Cleaned up redundant entries in example configuration files.
  • Tests

    • Removed unnecessary test data setup related to pseudopotential files.

@SchrodingersCattt SchrodingersCattt changed the base branch from master to devel August 1, 2025 11:17
Copy link
Contributor

coderabbitai bot commented Aug 1, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This update introduces changes across several modules: it improves pseudopotential and orbital file mapping in ABACUS SCF generation, adds automatic spin multiplicity calculation for CP2K input generation, adjusts perturbation loops in VASP MD data collection, refines model deviation file reading and system counting logic, updates a JSON example configuration, removes a test data line, and bumps the ruff linter version.

Changes

Cohort / File(s) Change Summary
Pre-commit Linter Version
.pre-commit-config.yaml
Updated the ruff Python linter version from v0.9.6 to v0.12.5.
VASP MD Perturbation Loop
dpgen/data/gen.py
Changed the perturbation index loop in coll_vasp_md from range(pert_numb) to range(pert_numb + 1), increasing the number of processed perturbations per scale by one.
ABACUS SCF Pseudopotential/Orbital Mapping
dpgen/generator/lib/abacus_scf.py
Enhanced make_abacus_scf_stru to use a type_map for explicit mapping of atom types to pseudopotential and orbital files, ensuring correct file alignment with atom ordering.
CP2K Multiplicity Calculation
dpgen/generator/lib/cp2k.py
Added an element-to-atomic-number dictionary and a calculate_multiplicity function. Modified make_cp2k_input to compute and insert spin multiplicity based on system composition and charge if not provided.
Generator Run Logic Adjustments
dpgen/generator/run.py
Replaced direct file loading with a helper function for model deviation reading and added a check to only count and append non-empty systems in post_fp_cp2k.
Example Configuration Cleanup
examples/run/dp2.x-lammps-cp2k/methane/param-ch4.json
Removed two redundant entries from the sys_batch_size array, reducing it from four to two elements.
Test Data Simplification
tests/data/test_gen_bulk_abacus.py
Removed the line assigning the "potcars" key in the testSTRU method, eliminating a redundant test data entry.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant make_cp2k_input
    participant calculate_multiplicity

    User->>make_cp2k_input: Provide sys_data, fp_params
    make_cp2k_input->>make_cp2k_input: Extract atom_names, atom_types, charge
    make_cp2k_input->>calculate_multiplicity: If multiplicity not in fp_params, compute using atom_names/types and charge
    calculate_multiplicity-->>make_cp2k_input: Return computed multiplicity
    make_cp2k_input->>make_cp2k_input: Merge multiplicity into input config
    make_cp2k_input-->>User: Return input string with correct multiplicity
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

Suggested reviewers

  • wanghan-iapcm

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b5fab4 and aa4d225.

📒 Files selected for processing (7)
  • .pre-commit-config.yaml (1 hunks)
  • dpgen/data/gen.py (1 hunks)
  • dpgen/generator/lib/abacus_scf.py (1 hunks)
  • dpgen/generator/lib/cp2k.py (3 hunks)
  • dpgen/generator/run.py (1 hunks)
  • examples/run/dp2.x-lammps-cp2k/methane/param-ch4.json (0 hunks)
  • tests/data/test_gen_bulk_abacus.py (0 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant