Repository navigation
Add a tutorial for the Debye-Waller workflow - #1592
Open
hrushikesh-s wants to merge 51 commits into
Open
hrushikesh-s wants to merge 51 commits into
hrushikesh-s wants to merge 51 commits into
Conversation
Co-authored-by: Ruby Keesey <164552150+rkeesey@users.noreply.github.com>
Co-authored-by: Ruby Keesey <164552150+rkeesey@users.noreply.github.com>
…nto debye-waller # Conflicts: # pyproject.toml
…n phonopy finds complex matrices
…des, compute them once per job
This was referenced Oct 9, 2026
…iment for all potentials
…e Debye-Waller tutorial
…nto thermal-displacements-fix # Conflicts: # src/atomate2/common/schemas/phonons.py
…nto debye-waller # Conflicts: # src/atomate2/common/schemas/phonons.py
…nto debye-waller-tutorial # Conflicts: # src/atomate2/common/schemas/phonons.py
# Conflicts: # docs/user/codes/vasp.md # src/atomate2/forcefields/flows/debye_waller.py
hrushikesh-s
marked this pull request as ready for review
October 12, 2026 23:29
5 tasks done
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.
Summary
Include a summary of major changes in bullet points:
tutorials/debye_waller_workflow.ipynbfor the Debye-Waller factors of Add Debye-Waller factors as an option of the phonon makers #1580, which needs Add Debye-Waller factors as an option of the phonon makers #1580 and Breaking: Leave out the acoustic modes at Gamma in the thermal displacement matrices #1590. It runs the force fieldPhononMakerwithcreate_thermal_displacements=Trueandcreate_debye_waller=True. It follows the layout of the thermal expansion and CALPHAD tutorials. Part A runs the workflows (cells taggedskip-execution). Part B draws all tables and figures from the stored numbers intests/test_data/forcefields/debye_waller_tutorial/dw_results.json.gz(36 KB) anddw_mlip_results.json.gz(84 KB), and CI runs it with nbmake in a few seconds.write_uwrites one U file per material and potential. B7 compares the eigenvalues of U with the pheasy reference. For the six stable materials at 300 K, MACE-OMAT-0 has the smallest MAE (6.3e-4 Ų) and the PBE potentials give U 20% to 27% larger than the PBEsol reference. B7 also plots the median and IQR of the eigenvalues over all sites against temperature, and compares each potential with experiment. MACE-OMAT-0 is closest, with a mean absolute difference of 6.7%.imaginary_modes_thermal_displacements="exclude"withfreq_min_thermal_displacements= 0.1 THz from Breaking: Leave out the acoustic modes at Gamma in the thermal displacement matrices #1590. The pheasy reference is also computed with "absolute", which counts each imaginary mode as a real mode of the same absolute frequency, as in R. Keesey's calculations. B8 compares the two. "absolute" makes the eigenvalues 4.6% larger in the median and up to 67 times larger for single sites, so U of these materials is only a rough estimate.docs/user/codes/vasp.mdand add it totutorials/tutorials.md.Part of #1591.
Additional dependencies introduced (if any)
List all new dependencies needed and justify why. While adding dependencies that bring
significantly useful functionality is perfectly fine, adding ones that add trivial
functionality, e.g., to use one single easily implementable function, is frowned upon.
Justify why that dependency is needed. Especially frowned upon are circular dependencies.
None. Part A needs the MACE-Field fork and the pymatgen of Add Debye-Waller factors as an option of the phonon makers #1580, as listed in the notebook. Part B needs only atomate2.
TODO (if any)
If this is a work-in-progress, write something about what else needs to be done.
Checklist
Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.
Before a pull request can be merged, the following items must be checked:
The easiest way to handle this is to run the following in the correct sequence on
your local machine. Start with running
ruffandruff formaton your new code. This willautomatically reformat your code to PEP8 conventions and fix many linting issues.
Run ruff on your code.
type check your code.
Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply run
pre-commit installand a check will be run prior to allowing commits.