Repository navigation
docs(manual): all-electron FLAPW + NMR/EFG/XPS tutorial - #525
Merged
Merged
Conversation
Documents the one big manual coverage gap: the all-electron FLAPW engine (task: flapw) and the NMR/EFG/XPS spectroscopy subsystem (task: nmr). Covers the three entry points with working YAML/api examples grounded in the real *Params surface and drivers: - task: flapw — all-electron muffin-tin SCF, Gamma eigenvalues, XPS initial-state core-level shifts - nmr.task=efg — all-electron FLAPW electric field gradient + C_Q - nmr.task=shielding — PW/PAW + GIPAW magnetic shielding, chemical shift, optional PAW EFG and powder spectra Documents the summary keys each returns, the shielding_level / efg / spectrum gates, and is honest about scope: FLAPW is a dense O(N^3) all-electron oracle (not a production large-cell path), absolute eigenvalues wander so only splittings/within-cell shifts are physical, and the realistic property path is PAW+GIPAW. Validation claims cite the committed tests (Ne/Ar splittings vs Elk, corundum Al EFG vs Elk, core-level shifts, GIPAW core Lamb / dia-aug). Adds an "All-electron and spectroscopy" Tutorials subsection to the nav. doc-refs clean; mkdocs build --strict clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The FLAPW/NMR page stated the absolute GIPAW sigma is "anchored to published diamond-Si 29Si" — that came from a plan doc, not an implemented/tested anchor (tests/unit/test_gipaw.py has no such reference). Replaced with the accurate statement: absolute shieldings become chemical shifts only via a user-supplied or api.reference_sigma_iso-computed reference; gradwave ships no built-in absolute standard. Other validation claims on the page are test-grounded and unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new manual tutorial page,
docs/manual/flapw-spectroscopy.md, covering the one big remaining manual coverage gap: the all-electron FLAPW engine (task: flapw) and the NMR/EFG/XPS spectroscopy subsystem (task: nmr).The page
Three entry points, each with a minimal working YAML and
api.runexample built from the real*Paramssurface:task: flapw— all-electron muffin-tin SCF: Γ eigenvalues, convergence, and initial-state (XPS) core-level shifts.nmr.task=efg— all-electron FLAPW electric field gradient (nmr.task=shielding— the plane-wave/PAW + GIPAW magnetic-shielding production path:Each section documents the exact
summary[...]keys returned, theshielding_level/efg/spectrumgates, and theflapw/nmrblock keys with defaults.Honest scope (as verified in the code)
fullpot, Kerker, Newton polish, converged k); the smoke-tier defaults are for wiring, not physics.Validation claims
All cited from committed tests: Ne/Ar$s$ –$p$ splittings vs Elk 11.0.2 (
test_flapw_scf.py), corundum ²⁷Al EFG vs Elk (~118 %, ±35 % band,test_flapw_efg_vs_elk.py), core-level shifts (test_flapw_core_levels.py), and GIPAW core-Lamb / diamagnetic-augmentation anchors (test_gipaw.py). No numbers invented.Nav
Adds an All-electron and spectroscopy subsection to the Tutorials tree.
Checks
make doc-refs— clean (all path references resolve).mkdocs build --strict— clean, exit 0.🤖 Generated with Claude Code