docs: clarify atomic_dipole meaning for DPLR models

[Copilot]

✅ UPDATED: Fixed Documentation Structure and Language

Changes Made Based on Review Comments

📝 Addressed Feedback from @njzjz

Issue: The inserted section broke the original content structure and the language was too informal.

Changes:

1. Fixed broken documentation structure

   • Removed the standalone section that was inserted in the middle of "Train a deep Wannier model for Wannier centroids"
   • Integrated the atomic_dipole explanation into the existing flow without breaking the section

2. Formalized language and presentation

   • Converted informal bullet points and step-by-step lists to more formal prose
   • Integrated the explanation naturally into the existing sentence about atomic_dipole being trained as labels
   • Maintained technical accuracy while using more formal documentation style

3. Restored proper content flow

   • The section now flows properly from the loss configuration to the atomic dipole explanation to the training commands
   • No longer interrupts the original structure of the "Train a deep Wannier model" section

📖 Final Result

The DPLR documentation now includes a concise, formal explanation of what atomic_dipole means in the DPLR context (displacement from atom to Wannier centroid) integrated seamlessly into the existing training workflow description, without breaking the document structure.

Fixes #4970.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[njzjz]

@copilot no need to add examples. Users just don't know what the atomic dipole is in the DPLR, but know how to create data.

[Copilot]

@copilot no need to add examples. Users just don't know what the atomic dipole is in the DPLR, but know how to create data.

You're right. I've removed the detailed examples and guides. The documentation now focuses on explaining what atomic_dipole means specifically in the DPLR context (displacement from atom to Wannier centroid) directly in the DPLR documentation where users need this information for training.

[Copilot]

Pull Request Overview

This PR clarifies the meaning of atomic dipole data in DPLR (Deep Potential for Long Range) models. The update addresses issue #4970 by adding a technical explanation of what atomic dipole represents in the DPLR context.

• Adds clarification that atomic dipole represents displacement vectors from atoms to Wannier centroids
• Provides the mathematical relationship: atomic_dipole = wannier_centroid_position - atom_position
• Mentions DFT calculation tools (VASP with Wannier90) for obtaining this data

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.20%. Comparing base (dd55dff) to head (03c8a56).
⚠️ Report is 76 commits behind head on devel.

Additional details and impacted files

@@           Coverage Diff           @@
##            devel    #4979   +/-   ##
=======================================
  Coverage   84.20%   84.20%           
=======================================
  Files         705      705           
  Lines       69229    69229           
  Branches     3576     3575    -1     
=======================================
  Hits        58292    58292           
  Misses       9797     9797           
  Partials     1140     1140           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.