Repository navigation
Conversation
The tutorial is renamed from "*ab initio* potentials with GPAW" to
"*ab initio* potentials", and the VASP material is added as a second half,
from a notebook contributed by a user who tested VASPPotential and
ChargeDensityPotential.
The page now covers all three routes to a DFT potential -- GPAWPotential,
VASPPotential, and ChargeDensityPotential for any other code -- and closes
with a section comparing their accuracy against converged GPAW references on
SrTiO3, hBN and MoS2.
The GPAW half is unchanged apart from being demoted one heading level under a
new "Potentials from a GPAW calculation" section, and one fix: the citation of
the experimental intensities was written `cite`{gpawpotential}, with the
braces and backticks the wrong way round and the key missing its final s, so
it rendered as literal text rather than a citation.
The VASP half keeps the contributor's code as written. The changes are
editorial: headings demoted to fit under "Potentials from a VASP calculation",
cross-references to "the chapter *ab initio potentials with GPAW*" rewritten
now that it is a section of the same page, abTEM spelled *ab*TEM as elsewhere
in the docs, the wide figures tagged full-width, a dead material_name
assignment dropped, and the import cell reduced to the VASP-specific imports,
since numpy/matplotlib/abtem are already imported in the hidden setup cell at
the top.
The file name stays charge_density.ipynb so the published URL and the
(walkthrough:charge_density) label referenced from the potentials walkthrough
keep working.
The notebook is not executed at build time (execute_notebooks: 'off'), which
is what makes the VASP half possible at all: POTCAR files are under the VASP
license, so its cells carry the contributor's stored outputs and read from
path/to/... placeholders.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This branch has not been deployed
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.
Combines the VASP documentation contributed by a tester with the existing GPAW tutorial, and renames the page from ab initio potentials with GPAW to ab initio potentials.
The page now covers all three routes to a DFT potential in one place:
GPAWPotentialVASPPotentialAECCAR2+POTCARPOTCARradial core densityChargeDensityPotentialStructure
What changed in the GPAW half
Nothing, apart from the headings being demoted one level under the new section — 21 of its 28 cells are byte-identical — and one fix. The citation of the experimental intensities was written
`cite`{gpawpotential}, with the braces and backticks the wrong way round and the key missing its finals, so it rendered as literal text instead of a citation. It now resolves.What changed in the contributed half
The code is as the contributor wrote it. The edits are editorial:
abTEMspelled*ab*TEM, as elsewhere in the docsfull-widthmaterial_nameassignment droppednumpy/matplotlib/abtemare already imported in the hidden setup cell at the topNotes
charge_density.ipynb, so the published URL and the(walkthrough:charge_density)label referenced from the potentials walkthrough keep working. Only the title changes.execute_notebooks: 'off'). That is what makes the VASP half possible:POTCARfiles are under the VASP license, so nothing executable can be shipped. Its cells carry the contributor's stored outputs and read frompath/to/...placeholders, which the text says explicitly.jupyter-book build docs/is clean for this page — no new warnings, and the three new cross-references resolve.VASPPotentialandChargeDensityPotential(valence_electrons=...)are not released yet; they are in abTEM#395 and abTEM#422. This page should land after those.🤖 Posted by Claude Code on behalf of Toma