Add option to check if imaginary modes exist in phonon/QHA calculations to ensure valid thermochemistry #131
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.
If a user wants to calculate thermochemistry, it must be done on a minimum energy structure otherwise it is not valid. Currently, there is no mechanism for the user to confirm the results are sensible. I have added a keyword argument
imag_mode_threshold: float | None = Nonethat will raise aRuntimErrorif there are imaginary modes below the user-provided threshold.Checklist
ruff.mypy.duecredit@due.dcitedecorators to reference relevant papers by DOI (example)Tip: Install
pre-commithooks to auto-check types and linting before every commit: