Repository navigation
Conversation
The field was annotated dict[Element, float], but enumerate_magnetic_orderings takes dict[str, float] and pymatgen looks moments up by species string, so Element keys never match. Spotted by @Luguza in materialsproject#1528. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
I think this is ready to merge. Unsure who is the correct reviewer - @esoteric-ephemera ? |
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.
Problem.
MagneticOrderingsMaker.default_magmomsis annotateddict[Element, float], butenumerate_magnetic_orderingstakesdict[str, float]and pymatgen looks moments up bysite.species_string. Element keys never match ("Fe" in {Element("Fe"): 1}isFalse), so a user who follows the type hint getsValueError: Not detected as magneticfrom the enumerator.Credit to @Luguza, who found this while porting the exchange workflow in #1528 (comment).
Fix. Annotate
dict[str, float]and state in the docstring that keys are element symbols.Tested. Ran
MagneticStructureEnumeratoron a rock-salt FeO cell:{Element("Fe"): 1.0}raises the error above,{"Fe": 1.0}gets past it. The module imports with the new annotation. This changes only the annotation and docstring, so no new test.🤖 Generated with Claude Code