Deprecate composition overrides in favor of direct CIF specification - #34
Merged
Conversation
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
Deprecates the
transition_metalandgroup_ivcomposition override fields inIntermetallicConfig. Users should now specify the starting material directly via the CIF file, with automatic validation that f-block elements are compatible with the search mode.Motivation
The previous approach of using a template CIF + composition overrides was confusing and not future-proof for:
Direct CIF specification makes the starting material explicit and enables more sophisticated structure definitions.
Changes
1. Config Validation (
core/config.py)transition_metal/group_ivfields now emitDeprecationWarningf_block_mode='u_only': requires U (atomic 92) in CIFf_block_mode='lanthanides_u'or'lanthanides_u_no_wrap': requires lanthanides (57-71) or U (92)f_block_mode='full_f_block': accepts all f-block elements2. Builder Documentation (
cli/builders.py)3. Documentation
REFACTOR_NOTES.mdwith full migration guideexamples/config_intermetallic_new_style.yamlshowing new approachBackward Compatibility
All existing configs continue to work (with deprecation warnings)
builders.pyremains functionalMigration Example
Before (deprecated):