feat: Deliver validated initial CIF preparation and workflow guidance - #18
Merged
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.
This change makes alloy starting CIF preparation usable from the CLI and desktop. Materials Project prototypes previously arrived as P1 files that the adaptation step refused; users also had to supply symmetry-equivalent cell axes manually.
The new
prepare-cifsworkflow validates the actual single metal orbit, restores chemically supported P1 symmetry into a conventional cell, and creates a fresh verified package containing initial CIFs, unchanged sources, per-phase provenance, a theoretical peak preview, and a refinement guide. It supports cited phase-specific lattice, coordinates and chemistry, attributed offline Ti scaffolds, host selection by atomic fraction, and configurable candidate attempts. The desktop dialog can load the result into local analysis and remains usable on small screens. Standalone adaptation links equivalent cell axes, recomputes formula/Z/mass, records output hashes and prevents concurrent replacement; provider errors redact credentials.Current project instructions, documentation navigation and contribution/release guidance are included with the linked README changes. The ordinary analysis and discovery workflows retain their existing scientific meaning. Inherited lattice parameters and nominal bulk chemistry are explicitly starting assumptions; no experimental phase identification, equilibrium partitioning or sample refinement is inferred.
Validation on Windows / Python 3.12:
The 6 environment-dependent skipped checks are not treated as experimental acceptance. Example outputs, credentials, original user data, build products and the local validation receipts are excluded from this change.