Skip to content

docs(manual): all-electron FLAPW + NMR/EFG/XPS tutorial - #525

Merged
wladerer merged 2 commits into
mainfrom
docs/flapw-nmr-manual
Sep 26, 2026
Merged

wladerer merged 2 commits into
mainfrom
docs/flapw-nmr-manual

Conversation

@wladerer

Copy link
Copy Markdown
Owner

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.run example built from the real *Params surface:

  • 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 ($V_{zz}$, $\eta$, tensor) and quadrupolar coupling $C_Q$.
  • nmr.task=shielding — the plane-wave/PAW + GIPAW magnetic-shielding production path: $\sigma$, chemical shift $\delta_\mathrm{iso}$, optional PAW EFG and powder-spectrum synthesis.

Each section documents the exact summary[...] keys returned, the shielding_level / efg / spectrum gates, and the flapw / nmr block keys with defaults.

Honest scope (as verified in the code)

  • FLAPW is a dense $O(N^3)$ all-electron oracle for small cells and code-to-code validation — not a production large-cell engine.
  • FLAPW absolute eigenvalues wander with the interstitial zero, so only splittings and within-cell shifts are physical (stated up front and repeated per section).
  • The realistic-material property path is PAW+GIPAW, distinguished clearly from the FLAPW oracle throughout.
  • Converged EFG magnitudes need the full potential (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

wladerer and others added 2 commits September 26, 2026 14:02
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>
@wladerer
wladerer merged commit e23c776 into main Sep 26, 2026
15 checks passed
@wladerer
wladerer deleted the docs/flapw-nmr-manual branch September 26, 2026 23:01
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